如何用Java记录包？

Question

在Java API中,我可以看到包的Javadoc注释.

我如何/在何处放置Javadoc注释来记录包？

Answer 1

从1.5开始,您可以定义package-info.java文件并为包提供标准的javadoc样式注释:

COM /富/ 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

在intellij中,您可以右键单击一个包,创建它的选项应该在新文件菜单下 (5认同)
直接链接到规范:http://docs.oracle.com/javase/specs/jls/se7/html/jls-7.html#jls-7.4.1 (3认同)

Answer 2

在Java 1.4之前,您必须提供HTML文件package.html,如其他答案中所述.

从Java 1.5开始,您还可以提供一个package-info.java包含常规Javadoc注释(无HTML)的文件.后者是首选,因为它为您提供了一些额外的功能(特别是包注释).

更新到我之前的评论:现在IDEA支持`package-info.java`就好了. (3认同)
+1提及两种方式,以及它们之间的本质区别.顺便说一下,至少IntelliJ IDEA目前对package.html有更好的支持(包名上的Ctrl-Q显示包Javadocs). (2认同)