Doxygen，如何描述Java包

Question

我不太确定我应该如何使用Doxygen记录Java包。在C ++中，您可以简单地描述声明的命名空间，但Java包永远不会真正显式声明。我试着在包mypackage.subpackage之前添加一个描述;声明但无济于事。我发现，如果我要制作一个新文件而只是做

，那就是那种作品

/**
@namespace mypackage.subpackage
@brief my description
*/

它会出现在wiki上，但是很奇怪，因为有些包被正确描述，其余的都是重复的（没有描述要描述的包，而是另一个空的并且具有相同名称的包是创建）

有没有人知道在Doxygen中描述Java包的正确方法？

Answer 1

来自stackoverflow.com/questions/7368584/doxygen-and-package-html的copypaste，以便于参考：

为Java包提供文档的新替代方法是使用名为package-info.java的文件而不是package.html。 （有意选择文件名不是有效的类名。）

它有不同的语法：

/**
 * any javadoc comments (including tags)
 */
package name;

Answer 2

如果您使用的是Java 1.4或更低版本，则必须拥有package.html这是一个完整格式的html文件。

1.4之后，您可以使用格式为

的package-info.java文件

/**
 * com.foo is a group of bar utils for operating on foo things.
 */
package com.foo;