Monday, October 1, 2012

Javadoc

A comment must:
1. immediately precede a public item
2. start with /** and end with */
Tags are:
@param name description
@return description
@throws type explanation
@deprecated
@see package_name.class_name
@author name
@version info
usage: javadoc [options] package_name
Options are:
-link link_to_other_docs (may be url to java doc)
-d documentation_directory (where to put after generation)
-author (extracts author info from comments)
-version
-classpath list_of_directories (overrides CLASSPATH)
-private (extracts even the privates, not good)

No comments:

Post a Comment