Java 应用程序的自动属性文档答案

【问题标题】：Automatic properties documentation for Java applicationJava 应用程序的自动属性文档
【发布时间】：2016-09-13 10:46:59
【问题描述】：

在 Java 应用程序中是否有用于配置属性的“类似 Javadoc”的工具？

我目前正在开发 Java 应用程序，它使用常用的 Java 属性文件进行配置。这是一个“企业应用”，所以我们有几十个属性，很难为它们提供文档支持。

所以我想找到一个工具或框架，它可以在代码中描述属性，例如使用注释，然后将文档导出到文件中。

我们已经使用 Javadoc 和 Swagger 来编写文档 - 这非常方便。为属性设置类似的东西会很有帮助。

【问题讨论】：

也许this SO 可能有用。不确定它是否适合您的项目
属性是否都位于一个位置（例如一些处理属性的bean/singleton），或者应用程序是否在应用程序的不同位置使用不同的属性？此外，您是否正在寻找在字段/方法/类级别上注释的属性？出于兴趣，Javadocs 将其默认系统属性描述为其 javadocs 的一部分。
所有属性都位于不同类的字段中。由于我们的应用程序具有基于插件的架构，并且插件可以拥有自己的系统属性，因此我们无法将所有属性移动到一个地方。

【解决方案1】：

您可以使用 PropDoc 来生成属性文件文档。 PropDoc 是一个实用程序，旨在提高 Java 属性文件的可文档性。

它可以读入标准的 Java 属性文件，并从属性的 cmets 中解析出类似 JavaDoc 的注释。结果是一个元模型，可用于生成有关文件中属性的文档。

有默认模板可以生成 HTML 格式的文档。您可以根据需要自定义该模板。它非常基本且易于使用。

您可以参考并从这里获取代码PropDoc。

PropDoc 是现成的工具，可用于生成属性文件。您也可以通过引用它的源来创建自己的。

【讨论】：