Tutorial by Topics: documenting

Documentation for java code is often generated using javadoc. Javadoc was created by Sun Microsystems for the purpose of generating API documentation in HTML format from java source code. Using the HTML format gives the convenience of being able to hyperlink related documents together. /** -- ...

Help text can be located before or after the function line, as long as there is not code between the function line and the start of the help text. Capitalization of the function name only bolds the name, and is not required. If a line is prepended with See also, any names on the line that mat...