function readOnly(count){ }
Starting November 20, the site will be set to read-only. On December 4, 2023,
forum discussions will move to the Trailblazer Community.
+ Start a Discussion
Ken KoellnerKen Koellner 

ApexDoc Anyone?

I like to put enough comments in my code to identify what stuff is without cluttering it up with verbose banners.  I also have to write design specs so other engineers can understand classes I write.  I'm faced with a quandry as the info I put in the few sentence in the comments at the top of each method and the few works off comment on each parameter are pretty much what I want in my design spec.  I don't want to have to write it twice.

 

I was thinking, it would be cool if I could annotate the code and run a util like Javadoc on it.

 

Anyone know if there's anything like that for Apex?

 

If not, would apex ignore annotation and do you think javadoc would run on it as is?

 

-Ken

 

anan

I have been using this utility, has been working pretty nicely.

 

http://techsahre.blogspot.com/2011/01/apexdoc-salesforce-code-documentation.html