我目前正在使用Java应用程序,它使用通用的Java属性文件进行配置.这是一个“企业应用程序”,所以我们有几十个属性,很难支持他们的文档.
所以我想找到一个工具或框架,使得可以在代码中描述属性,例如使用注释,然后将文档导出到文件中.
我们已经使用Javadoc和Swagger进行文档化 – 这是非常方便的.对于属性有类似的东西是有帮助的.
它可以读取标准的Java属性文件,并从属性的注释中解析类似JavaDoc的注释.结果是一个元模型,可用于生成文件中属性的文档.
有默认的模板,将以HTML格式生成您的文档.您可以根据需要定制该模板.它非常基本和易于使用.
你可以参考并从这里获得代码PropDoc.
PropDoc是可以用于属性文件生成的准备工具.您也可以通过引用它的来源来创建自己的.
