如何记录 .properties 文件？

Question

是否有记录 .properties 文件的标准方法？本着 Javadoc 的精神，我在同一个文件中拥有属性和文档，并且可以利用 IDE 集成？

这听起来可能微不足道，但为了说明我的问题，请考虑以下示例：假设我有一个 Java 应用程序，它由格式为

的中央 .properties 文件控制

key1=value1
key2=value2

为了记录 属性 键的含义，我可以使用这样的注释：

# key1 does this and that
key1=value1

但是如果我的设置被应用了不止一次怎么办？

# key1 causes component1 to behave so and so
component1.key1=value1

# key1 causes component2 to behave so and so
component2.key1=value2

上面两个属性中key1的含义是一样的。但是，我不想重复评论，因为我可能有数百个应用了 key1 属性 的组件。我可以像这样在开头使用一条评论：

# key1 causes the affected component to behave so and so
component1.key1=value1
component2.key1=value2
....

但是如果我在最后添加一个新组件，我每次都必须向上滚动才能找到相关的文档注释。

我正在寻找一种方法来定义 属性 模式的含义

[COMPONENT].key1=value1

在某种程度上，我可以轻松地在 IDE 中引用该文档 - 就像您使用 Java 代码和 Javadoc.

一样

Answer 1

如果您的配置那么复杂，我会考虑使用 Typesafe 配置 https://github.com/typesafehub/config/blob/master/README.md

这样做将允许您构建配置以使用 json 或 hcon 删除重复项。

完成之后，无论加载什么配置，都应该对其进行验证并报告任何问题。如果成功，构建这个复杂配置的对象表示。 JavaJava 中的 bean，Scala 中的案例 类。

记录加载配置的代码和表示配置的代码。

我在 Scala 项目中使用过这种方法，它避免了很多痛苦和困惑。