function readOnly(count){ }
Sign Up ›
Starting November 20, the site will be set to read-only. On December 4, 2023,
forum discussions will move to the Trailblazer Community.
Learn More

Browse by Topic
ShowAll Questionssorted byDate Posted
+ Start a Discussion
sfdcJonsfdcJon 

Apex/VF Documentation

Hey guys,

 

Does anyone have good examples of documentation they've written for custom Apex/VF? I basically have a handful of new classes, and I want to document what they do, testing procedures, what they affect, etc.

 

Any examples out there would be great!

 

Cheers,

Jon

sfdcfoxsfdcfox

One fairly good tool is http://techsahre.blogspot.com/2011/01/apexdoc-salesforce-code-documentation.html ApexDoc, which uses a Java-like syntax to generate documentation. I'm also working on my own tool for code documentation that is more "salesforce-y".
scox67scox67
Hey all - I just posted a new version of SfApexDoc (https://gitlab.com/StevenWCox/sfapexdoc/wikis/home). Check out the release notes, documentation format, and usage details.
  • parses javadoc-style comments and creates HTML documentation
  • recognizes standard tags such as @description, @author, @date, @return, @param, @see, and @throws
  • creates links to standard Apex types as well as your own classes
  • includes full class, method, and property signatures - even those that span multiple lines
  • allows customization of output styling