在.properties文件中添加注释

Question

通过使用build.xml文件中的以下代码块

<propertyfile file="default.properties" comment="Default properties">
   <entry key="source.dir" value="1" />
   <entry key="dir.publish" value="1" />
   <entry key="dir.publish.html" value="1" />
</propertyfile>

我能够生成default.properties具有以下文件内容的文件

source.dir=1
dir.publish=1
dir.publish.html=1

我想知道如何在生成的文件中添加评论？例如，生成的属性应具有以下内容：

# Default Configuration
source.dir=1
dir.publish=1
# Source Configuration
dir.publish.html=1

我如何使用Ant来动态地做到这一点build.xml？

Answer 1

不支持编写带有多个注释的属性文件。为什么呢

PropertyFile.java

public class PropertyFile extends Task {

    /* ========================================================================
     *
     * Instance variables.
     */

    // Use this to prepend a message to the properties file
    private String              comment;

    private Properties          properties;

ant属性文件任务由一个java.util.Properties类支持，该类使用store（）方法存储注释。从任务中仅提取一条注释，并将其传递给Properties类以保存到文件中。

解决此问题的方法是编写自己的任务，该任务由commons属性而不是java.util.Properties。公共属性文件由属性布局支持，该属性布局允许对属性文件中的各个键进行设置注释。使用save（）方法保存属性文件，然后修改新任务以通过<comment>元素接受多个注释
。