How Do I Document Packages in Java?
In the Java APIs I can see Javadoc comments for packages.
How/where do I place Javadoc comments to document a package?
-
As of 1.5 you can define a
package-info.javafile and provide a standard javadoc style comment for a package:com/foo/package-info.java:
/** * com.foo is a group of bar utils for operating on foo things. */ package com.foo; //rest of the file is emptyLanguage specification for packages
讨论(0) -
Up to and including Java 1.4, you had to provide a HTML file package.html, as described in the other answers.
Since Java 1.5 you can also provide a
package-info.java, which contains a regular Javadoc comment (no HTML). The latter is preferred, as it gives you some extra features (notably package annotations).Details: Sun's docs for javadoc
讨论(0) -
With a
package.htmlfile at the package level (i.e. in the directory for that package). This should be a fully-formedHTMLfile, with the<html>tag defined in it讨论(0)
加载中...
- 热议问题