如何向 PropertiesConfiguration 文件写入注释？

Question

给定以下实例之一： org.apache.commons.configuration.PropertiesConfiguration 我想写一条评论。如何？

pc = new PropertiesConfiguration();

writeComment("this is a comment about the stuff below"); // HOW DO I WRITE THIS?
pc.addProperty("label0", myString);
writeComment("end of the stuff that needed a comment.");

编辑：我有一个粗略的解决方案。希望它能够得到改进。

---

这是我能做的最好的事情。它在文件中留下了无关的行。

pc = new PropertiesConfiguration();
writeComment(pc, "The following needed a comment so this is a comment.");
pc.addProperty(label0, stuff0);
writeComment(pc, "End of the stuff that needed a comment.");

...
 private void writeComment(PropertiesConfiguration pc, String s)
 {
    String propertyName = String.format("%s%d", "comment", this.commentNumber++);

    pc.getLayout().setComment(propertyName, s + " (" + propertyName + ")");

    // make a dummy property 
    pc.addProperty(propertyName, "."); 
         // put in a dummy right-hand-side value so the = sign is not lonely 
 }

这种方法的问题之一是 PropertiesConfiguration 文档对布局有点模糊。它没有明确表示注释将出现在虚拟行上方，因此 PropertiesConfiguration 似乎存在在后续调用中可以自由重新排列文件的风险。我什至没有看到保留属性行顺序的保证，因此我无法保证注释（和虚拟行）始终位于注释适用的属性之上：属性label0。当然，我在这里有点偏执。然而，文档确实说布局不能保证保持不变。 希望有人能够想出一些没有虚拟行和 Java 文档或网站保证的东西，以保证评论相对于要评论的属性的位置。编辑：您可能想知道为什么我会这样做创建一个虚拟属性，而不是仅将注释附加到文件中已有的属性之一。原因是因为我想要一个注释来引入属性块，并且可以进行更改（新属性或顺序切换）。我不想造成维护问题。我的评论应该说“这是数据挖掘结果的部分”或“这是时间表的部分”，我永远不必重新访问它。

Answer 1

就这样评论？

# This is comment

Answer 2

PropertiesConfiguration JavaDoc 文档

 Blank lines and lines starting with character '#' or '!' are skipped. 

编辑< /strong>：好的，您想从代码中编写注释。也许 - 如果您只需要编写属性文件 - 您可以使用 PropertiesConfiguration.PropertiesWriter 及其 writeComment 像这样的方法：

FileWriter writer = new FileWriter("test.properties");
PropertiesWriter propWriter = new PropertiesWriter(writer, ';');

propWriter.writeComment("Example properties");
propWriter.writeProperty("prop1","foo");
propWriter.writeProperty("prop2", "bar");

propWriter.close();

属性文件将如下所示：

# Example properties
prop1 = foo
prop2 = bar

更新

总结：PropertiesConfiguration 不提供您正在寻找的功能。