如何記錄.properties文件？

是否有標準的.properties文件文件的方式？在Javadoc的精神中，我在同一個文件中擁有屬性和文檔，並且可以利用IDE集成？如何記錄.properties文件？

這聽起來微不足道，但爲了說明我的問題，請看下面的例子：比方說，我有一個由中央屬性文件格式

key1=value1 
key2=value2

控制的Java應用程序文件的含義財產鑰匙我可以使用這樣的評論：

# 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 
....

不過，如果我在最後添加一個新的組件，我會每找到相關文檔註釋時間向上滾動。

我正在尋找一種方式，一種方式，我可以很容易地指的是文檔中的IDE來定義屬性式樣

[COMPONENT].key1=value1

的含義 - 就像你用Java代碼和Javadoc做。

2015-02-07 hennes

不完全清楚你在做什麼？你在尋找意見嗎？ – SMA 2015-02-07 17:26:35

對於存儲值的文檔是否重要？我將構建一個Java包裝器，用於將屬性文件加載到正確且充分記錄字段的屬性對象中。 – Smutje 2015-02-07 17:54:02

您可以使用'＃'字符向屬性文件添加註釋，但是沒有良好的API支持來保留和閱讀這些註釋。 – eckes 2015-02-07 17:56:08

如果你的配置是複雜的我會考慮使用類型安全配置https://github.com/typesafehub/config/blob/master/README.md

這樣做將使您構造配置使用JSON或HCON刪除重複。

這樣做後，無論加載配置應該驗證它並報告任何問題。如果成功，則構建這個複雜配置的obect表示。 Java中的Javabean，Scala中的案例類。

記錄加載配置的代碼和代表配置的代碼。

我在Scala項目中使用了這種方法，它節省了很多痛苦和困惑。

2015-02-08 09:05:07

回答