如何记录.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 config https://github.com/typesafehub/config/blob/master/README.md

这样做可以让您构建配置以使用json或hcon删除重复。

完成此操作后，无论配置如何加载，都应对其进行验证并报告任何问题。如果成功，请构建此复杂配置的对象表示。 Java中的Javabean，Scala中的case类。

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

我在Scala项目中使用过这种方法，这样可以省去很多痛苦和困惑。