Python 文・インデント・コメント: 明確なガイド

Python 文、インデント、コメント

このガイドでは、Python文、一貫したインデントの重要性、コメントとドキュメント文字列の効果的な使い方を解説します。

インタプリタが実行するPythonの指示を文と呼びます。代表例として、a = 1のような代入文、if、for、whileなどの制御フロー文があります。これらはすべてのPythonプログラムの構成要素です。

デフォルトでは改行で文が終端します。長い文を複数行に分割するには、バックスラッシュ(\)行継続文字を使用：

a = 1 + 2 + 3 + \
4 + 5 + 6 + \
7 + 8 + 9

より慣用的なのは、括弧、ブラケット、ブレース内での暗黙的継続：

a = (1 + 2 + 3 + 4 + 5 + 6 + 7 + 8 + 9)

同様に、リストリテラルも複数行に書けます：

colors = ['red', 'blue', 'green']

セミコロンで複数の簡単な文を1行に書くことも可能：

a = 1; b = 2; c = 3

ブレースでブロックを定義する言語とは異なり、Pythonはインデントのみでコードブロックを定義します。ブロックはコロンの後で始まり、ブロック開始位置相対でインデントされていない最初の行で終わります。

言語は任意の一貫したインデントレベルを許可しますが、コミュニティ標準はスペース4つ。タブは混乱を招くため避けるべきです。

for i in range(1, 11):
    print(i)
    if i == 5:
        break

適切なインデントは構文を強制するだけでなく、コードを即座に読みやすく保守しやすくします。例：

if True:
    print('Hello')
    a = 5

対して、可読性の低い1行形式：

if True: print('Hello'); a = 5

不正なインデントはIndentationErrorを引き起こし、実行を停止させます。

コメントは意図とロジックの文書化に不可欠で、特に数ヶ月後にコードを見返す際に重要です。Pythonでは、コメントはハッシュ(#)で始まり行末まで続きます。インタプリタはこれらの行を完全に無視します。

# This is a comment
# Print greeting
print('Hello')

複数行にわたるには、各行に#を付ける：

# This is a long comment
# that continues over several
# lines

あるいは、トリプルクォート文字列をブロックコメントとして使用できます。代入もドキュメント文字列としても使われない場合、インタプリタによって破棄され、ランタイムコストはゼロです：

"""This is a multi-line comment that spans several lines."""

ドキュメント文字列(docstring)は、関数、クラス、モジュール定義の直後に置かれる文字列リテラルです。要素の目的を文書化し、その__doc__属性に格納されます。トリプルクォートが慣習的に使われます：

def double(num):
    """Return twice the input value."""
    return 2 * num

プログラムからアクセス可能：

print(double.__doc__)

出力：

Return twice the input value.

詳細なガイドラインは、公式Pythonドキュメントのコメントとドキュメント文字列を参照してください。

Python