概要
Python
では、複数行コメント用の専用構文は存在しません。代わりに、#
を使ってシングルラインコメントを複数行にわたって連続させる方法が推奨されています。また、文字列リテラルをコメント代わりに使用することは、非推奨です。PEP 8スタイルガイドでも、シングルラインコメントを使うことが記載されています。
シングルラインコメントの活用
Python
では、次のように #
を使って連続したシングルラインコメントで複数行をカバーします。
# これは複数行のコメントの例です。
# それぞれの行は `#` で始めます。
# この形式が推奨されています。
この方法は、シンプルで可読性が高く、Python
のスタイルガイドPEP 8
でも推奨されています。特にコードエディタのショートカット(例: Ctrl + /
)を使うと、一度に複数行をコメントアウトすることが可能です。
文字列リテラルの使用とその問題点
文字列リテラル(例: '''
や """
)を使うことで、実行されない複数行のテキストを記述できます。しかし、これらは「コメント」として解釈されず、文字列として扱われます。このため、スタイルガイドやコード解析ツールで問題となることがあります。
'''
この方法は非推奨です。
実行時には無視されますが、
文字列としては解釈されるため、コメントではありません。
'''
PEP 8の推奨スタイル
PEP 8は、Python
の公式スタイルガイドとして、シンプルで一貫したシングルラインコメントの使用を推奨しています。コメントを段落に区切る場合は、空行を挿入して視覚的に分けるとよいとされています。
結論
Python
で複数行コメントを作成する際は、シングルラインコメントを連続して使う方法が最も適切です。PEP 8に従い、シンプルかつ読みやすいコメントスタイルを心がけましょう。