ヒアドキュメントの基礎と活用法

Ruby

txt = <<~DOC
ここに複数行の文字列を書くことができます。
インデントも自動で削除されます。
DOC

Bash (シェルスクリプト)

cat <<'EOF'
この中に書かれたテキストはそのまま出力されます。
変数展開は行われません。
EOF

メリットとデメリット

• 可読性が向上：長い文字列でもコードが散らかりません。
• 保守性が高い：文字列内部の改行やインデントが保持されるため、変更が容易です。
• デバッグが容易：実際に出力される形とコードが一致します。
• デメリット：言語によって構文が微妙に異なるため、チーム内で統一が必要です。
• 過度に使用すると、テンプレートエンジンや外部ファイルへの分割が適切な場合があります。

ベストプラクティス

以下のポイントに留意してヒアドキュメントを活用しましょう。

• タグやプレースホルダーを使う場合は、明確な終了識別子を設定する。
• インデントを揃えることで、コード全体の見た目を統一する。
• 外部に長いテンプレートが必要な場合は、ファイル分割を検討する。
• 変数展開が必要かどうかを意識し、シングルクォート形式（例: <<'EOF'）で安全に扱う。

ヒアドキュメントは、適切に使うとコードの可読性と保守性を大幅に向上させます。プロジェクトや言語の特性に合わせて活用してください。