Java – 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?

Best Solution

As of 1.5 you can define a file and provide a standard javadoc style comment for a package:


 * is a group of bar utils for operating on foo things.

//rest of the file is empty

Language specification for packages