Pythonのdict()内にコメントを記述する方法｜複数行コメントが使えない理由と代替策

Pythonスクリプトでは、通常どおりコードの任意の場所にコメントを記述できます。ただし、dict（辞書）の定義内で使用できるのは「#」による1行コメントのみである点に注意が必要です。

複数行コメントとしてよく使われるトリプルクォート（"""）は、実際には文字列リテラルとして扱われます。そのため、dictの定義の途中に単独で文字列を置くことはできず、構文エラーになります。これは、dictリテラルが「キー: 値」のペアしか受け付けないためです。

正しい例：#を使った1行コメント

次のように、#を使ったコメントであればdict定義内でも問題なく記述できます。

testItems = {
    'TestOne': 'Hello',
    # 'TestTwo': None,
}

誤った例：トリプルクォートによる複数行コメント

一方、以下のコードは無効です。トリプルクォートで囲まれた部分は文字列とみなされ、dictの要素として解釈できないためエラーが発生します。

testItems = {
    'TestOne': 'Hello',
    """
    Some random
    multiline comment
    """
}

複数行にわたるコメントを書きたい場合の対処法

dict定義内で長めの説明を残したい場合は、各行の先頭に#を付けて、複数行の1行コメントとして記述するのが一般的です。

testItems = {
    'TestOne': 'Hello',
    # 'TestTwo' は未実装のため一時的にコメントアウト
    # 後日 API 連携時に有効化する予定
    # 'TestTwo': None,
}

このようにすれば、dictの構造を壊すことなく、自由にコメントを追加できます。