PropertiesをJSONに変換する際のコメント保持
.propertiesファイルをJSONに変換する際に#と!コメントを_comments配列としてメタデータに保持します。
Syntax Features
詳細な説明
コメントの保持
.propertiesファイルのコメント(#または!で始まる行)には貴重なドキュメンテーションが含まれています:セクションヘッダー、作者メモ、非推奨警告、設定説明。コメント保持機能はこれらをJSON出力にキャプチャします。
コメント保持を使うべき場合
- ドキュメント生成: 設定と並んでコメントをドキュメントとして抽出
- 監査証跡: 作者とタイムスタンプのアノテーションを保持
- 移行: フォーマット移行中に警告コメントを表示し続ける
注意:特定のキーに対するコメントの位置は保持されません(すべてのコメントは単一の_comments配列に収集されます)。
ユースケース
監査証跡のためにドキュメンテーションコメントを保持しながら.properties設定ファイルをJSONに移行、設定ドキュメンテーションの生成、またはフォーマット移行中の警告アノテーションの維持。