Skip to content
Search

Javadoc

lastmod 2025-02-14created 2014-03-173 edits

Javadoc is a documentation generator from Oracle Corporation for generating API documentation in HTML format from Java source code. The HTML format is used to add the convenience of being able to hyperlink related documents together.

For javadoc documentation, comments must start with /** and end with */.

Creating Javadoc & Korean output

The command-line options are as follows. 

-locale ko_KR -encoding UTF-8 -charset UTF-8 -docencoding UTF-8

package-info

Create a package-info.java file for each package and enter information about the package. Write the file contents as follows. 

/**
 * test package info file.
 * @author username
 */
package android.test;

Tags

  • @author: Author name.
  • @version: Version information.
  • @return: Information about the return value.
  • @exception: Describes exceptions that may be thrown.
  • @throws: Same as @exception.
  • @deprecated: Marks the method as not recommended (scheduled for removal).
  • @param: Description of a parameter.
  • @serial: Describes a serializable class member.
  • @see: Cross-reference to a class, method, field, URL, etc. (provides a link).
  • @since: Indicates when it was updated (version, date, etc. can be given).

Tips

  • The last line of every file must be an empty line.
  • The last character of every sentence must be a period (.).

See also

Favorite site

author Zer0 sitemap