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

Evg*_*sov 12 java properties

在Java应用程序中是否有用于配置属性的"类Javadoc"工具?

我目前正在研究Java应用程序,它使用通常的Java属性文件进行配置.这是一个"企业应用程序",所以我们有很多属性,而且很难为它们提供文档支持.

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

我们已经使用Javadoc和Swagger作为文档 - 它非常方便.为属性提供类似的东西会很有帮助.

Abh*_*eet 10

您可以将PropDoc用于属性文件文档生成.PropDoc是一个旨在提高Java Properties文件可记录性的实用程序.

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

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

您可以从PropDoc中引用并获取代码.

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