File APIs for Java Developers
Manipulate DOC, XLS, PPT, PDF and many others from your application.
http://aspose.com/file-tools
The moose likes Developer Certification (SCJD/OCMJD) and the fly likes JavaDoc w/ private methods Big Moose Saloon
  Search | Java FAQ | Recent Topics
Register / Login
JavaRanch » Java Forums » Professional Certification » Developer Certification (SCJD/OCMJD)
Reply locked New topic
Author

JavaDoc w/ private methods

Matt DeLacey
Ranch Hand

Joined: Oct 12, 2000
Posts: 318
Hello,
Should we provide JavaDoc style comments for our
private methods? By default, I believe JavaDoc
ignores things with private modifier. I was going
to provide JavaDoc style comments for everything
with access restrictio looser than private and provide
regular comments for private access modifier. Does
this seem reasonable?
With Respect,
Matt
Matt DeLacey
Ranch Hand

Joined: Oct 12, 2000
Posts: 318
Whoops! Sorry. This has already been addressed. If you're
interested, look here:
http://www.javaranch.com/ubb/Forum25/HTML/000274.html
With Respect,
Matt
 
IntelliJ Java IDE
 
subject: JavaDoc w/ private methods
 
Threads others viewed
Question about comments
Java Docs
B&S: What types do you comment with javadoc?
I want to ask 2 questions about javadoc.
Disallowed to use private inner classes?
IntelliJ Java IDE