package - Doxygen 和 package.html

Question

根据 javadoc 规范，我在相关包的根目录中放置了一个名为 package-info.html 的文档文件。但是，当我在该文件夹上运行 Doxygen 时，不会拾取该文件中的文档。我如何告诉 Doxygen 使用这个文件作为包文档？我也尝试过旧规范 package.html，但这不起作用。

Answer 1

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

它有不同的语法:

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

这也是提供包注释的唯一方法(如果有，在 package 关键字之前注明)。

从您对问题的评论来看，最近版本的 Doxygen 似乎只了解这个 package-info.java ，而不是旧的 package.html文件。

我记得有人提出了一个模块系统，然后会添加一个类似的 module-info.java文件，但经过短暂的谷歌搜索后我现在找不到它。 (也许是 JSR 294？)