Web Version Guide1

コメント保持機能

YAMLコメントを保持する方法

コメント保持機能

YAMLのコメントを変換後も維持する方法を解説します。


💬 なぜコメント保持が重要?

設定ファイルのコメントには重要な情報が含まれます:

# 本番環境のデータベース設定
# 変更時は運用チームに連絡すること
database:
  host: db.prod.example.com  # マスターDB
  port: 5432  # デフォルトポート
  pool_size: 20  # 負荷テスト結果に基づく値

❌ 従来のツールの問題

JSONはコメントをサポートしていないため、変換時にすべて消えます。


✅ YAMLforgeの解決策

YAMLforgeは、コメントを特別なメタデータとして保存します。

使い方

  1. 「コメントを保持」オプションをON
  2. 変換を実行
  3. JSON→YAMLに戻す時にコメントが復元

📊 対応するコメント形式

コメント形式対応
行コメント #
インラインコメント
複数行コメント
ドキュメント先頭コメント
タグ
#comment#yaml#feature#preservation