java - 是否可以限制 JavaDocs 生成中的特定属性/字段？

Question

我有一些 Java 类，其中包含一个或多个属性，我希望在生成这些类时将其从 JavaDoc 中排除。我正在使用“maven-javadoc-plugin”，但找不到任何表明这是可能的文档。

是否有可以在POM中应用的标签，也可以在Java类中的实际属性上放置注释，以便排除特定属性？

我知道可以使用 <excludePackageNames /> 在包级别完成排除POM 中的标记。此外，似乎还可以通过使用 <sourceFileExcludes /> 从 JavaDoc 中限制特定类标签，只要是<sourcepath />也已定义。

作为替代方案，我使用 RAML 1.0 为该项目生成 API 文档，所以有人知道是否存在可以应用 RAML 特定的排除来防止包含文档？当然，JavaDocs 是与 RAML 文档分开生成的，因此限制 RAML 端的各个类属性/字段(如果可能)仍然需要 JavaDocs 排除，以便 Maven JavaDocs 插件也会忽略它们。

提前谢谢您!尽管我预计答案是否定的。

Answer 1

这里有两种可能的解决方案。

1. 编写您自己的 doclet。 API 文档(描述 Java 类的 HTML 页面)是由 standard doclet 根据 Javadoc 注释生成的。 。该 doclet 是开源代码。您可以复制该 doclet，稍微更改一下，然后运行修改后的版本来创建 API 文档。

2. 定义将出现在 HTML 文档中的注释 @NotDocumented。在类的“ secret ”字段/方法上编写注释。正常创建 HTML API 文档。使用 perl、awk 或 sed 等文本处理工具对 HTML API 文档进行后处理，以删除对 @NotDocumented 成员的所有引用。