可以从JavaDocs生成中限制特定的属性/字段吗？

Question

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

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

我知道可以使用POM中的<excludePackageNames />标签在程序包级别进行排除。此外，似乎还可以通过使用<sourceFileExcludes />标签从JavaDocs中限制特定类，只要还定义了<sourcepath />。

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

先谢谢您！尽管我希望答案将是负面的。

Answer 1

这是两种可能的解决方案。

1. 编写您自己的doclet。 API文档（描述Java类的HTML页面）由standard doclet根据Javadoc注释生成。该doclet是开源代码。您可以复制该doclet，对其进行少许更改，然后运行修改后的版本以创建API文档。

2. 定义将在HTML文档中显示的注释@NotDocumented。在类的“秘密”字段/方法上写注释。通常创建HTML API文档。使用诸如perl，awk或sed之类的文本处理工具对HTML API文档进行后处理，以剥离对@NotDocumented成员的所有引用。