ヒアドキュメントって何？

auです。

ヒアドキュメントという用語について調べてみました。

ヒアドキュメントとは

ヒアドキュメントとは、プログラミングなどで特殊な記号などを含む文字列をソースコードに埋め込む記法のことです。
どうやらプログラミング言語によって書き方は違うみたいです。
よく使うPythonを調べてみます。

Pythonの場合は、"""(ダブルクォート3つ)で囲むか、'''(シングルクォート3つ)で囲むとヒアドキュメントになるようです。

string1 = '''
これはテストの
ドキュメントです。
'''

print(string1)
print("----------")

# \で改行コードを無視できる
string2 = '''\
これはテストの
ドキュメントです。\
'''

print(string2)

# textwrapを使う
import textwrap

if True:
    string3 = '''
    これはインテントがある場合の
    ドキュメントです。
    '''
# dedentでインテント削除、strip()で改行コードを削除
print(textwrap.dedent(string3).strip())

# 実行結果

これはテストの
ドキュメントです。

----------
これはテストの
ドキュメントです。
----------
これはインテントがある場合の
ドキュメントです。

\n\nという風に書いてあるより綺麗に見えますね。これからはこんな感じで書いていこうと思います。

参考

qiita.com