3

我不太确定我应该如何使用 Doxygen 记录 Java 包。在 C++ 中,您可以简单地描述一个名称空间,因为它已声明,但 Java 包从未真正显式声明。我尝试在包 mypackage.subpackage; 之前添加描述。声明但无济于事。我发现这种工作是如果我要制作一个新文件并简单地做

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

它会出现在 wiki 上,但这很奇怪,因为某些包被正确描述,而其余包被重复(没有描述要描述的包,而是创建了另一个空的并具有相同名称的包)

有谁知道在 Doxygen 中描述 Java 包的正确方法?

4

2 回答 2

2

来自stackoverflow.com/questions/7368584/doxygen-and-package-html的复制粘贴,以便于参考:

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

它有不同的语法:

/**
 * any javadoc comments (including tags)
 */
package name;
于 2012-11-17T10:03:12.110 回答
1

如果您使用的是 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;
于 2017-01-12T21:41:56.310 回答