In the Java APIs I can see Javadoc comments for packages.
How/where do I place Javadoc comments to document a package?
Add a comment |
3 Answers
As of 1.5 you can define a package-info.java file 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 empty 
3 Comments
gavenkoa
Direct link to spec: docs.oracle.com/javase/specs/jls/se7/html/jls-7.html#jls-7.4.1
bsautner
in intellij you can right click on a package and the option to create this should be under the new file menu
trindflo
I found the file needed to be in packagename/src/packagename (with the rest of the source files)
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
2 Comments
Jonik
+1 for mentioning both ways, and the essential difference between them. By the way, at least IntelliJ IDEA currently has better support for package.html (Ctrl-Q on a package name shows the package Javadocs).
Jonik
Update to my previous comment: nowadays IDEA supports
package-info.java just fine.With a package.html file at the package level (i.e. in the directory for that package). This should be a fully-formed HTML file, with the <html> tag defined in it
3 Comments
jjnguy
More details? What should the file look like?
oxbow_lakes
It's an HTML file containing the description of your package. That's it!
k2col
This is the old way to do it. From Java 1.5 onwards you can use package-info.java