Pythonのコメントとインデントについて

はるか

Pythonのコメントって、どうしてそんなに重要なんだろう？

ふゅか

あ、それね！コメントはコードをわかりやすくするためにあるのよ♪ 他の人が見たときにも、何をしているのかすぐに理解できるし、自分が後で見返すときも助かるわ！

はるか

なるほど、コメントはコードを読む手助けになる。

1. コメント

Pythonでは、コメントを使ってコードの説明や補足情報を書くことができます。コメントは実行されず、プログラムの動作に影響を与えません。コメントはコードを他の開発者や未来の自分が理解しやすくするために重要です。

1.1. 単一行コメント

単一行のコメントは、# を使って記述します。この # の後に続く内容は、その行の終わりまでコメントとして扱われます。

# これは単一行コメントです
print("Hello, World!")  # この行もコメントを含んでいます

1.2. 複数行コメント

複数行に渡るコメントを挿入したい場合は、一般的に各行の先頭に # をつけます。

# これは複数行に渡るコメントです
# 各行の先頭に # をつけることで、コメントを続けることができます

また、ドキュメント文字列（docstring）を使用して、関数やクラスの説明を記述することもできます。これには三重引用符 """ を使います。docstring はコメントではなく、実行時にもアクセス可能ですが、説明を追加するための手段として使われます。

def greet():
    """この関数は挨拶を表示します"""
    print("Hello!")

2. インデント

はるか

インデントもPythonでは重要だよね。

ふゅか

うん！インデントはコードの構造を示すために不可欠なの！4つのスペースが標準だけど、タブを使ってもOK。ただし、スペースとタブを混ぜるとエラーになることがあるから注意ね♪

Pythonはインデント（字下げ）を使って、コードのブロック（構造）を表現します。他のプログラミング言語では {} や begin-end などの構文でブロックを明示しますが、Pythonではインデントがブロックの境界を示します。

2.1. 基本的なルール

• インデントは一般的に4つのスペースを使います。
• Pythonでは、ブロックごとにインデントを1レベル深くします。たとえば、if 文やループ、関数定義などの中で使います。

if True:
    print("This is inside the if statement")  # インデントされています
print("This is outside the if statement")  # インデントされていません

2.2. 関数定義とインデント

関数内でも、インデントを使ってブロックの内容を示します。

def my_function():
    print("Hello, inside the function!")  # 関数内でインデントされています

my_function()

2.3. インデントエラー

Pythonではインデントがコードの構造を決めるため、不正なインデントは構文エラー（IndentationError）を引き起こします。インデントが不揃いだと、Pythonは正しくブロックを識別できません。

if True:
    print("Correctly indented")
  print("This will raise an error!")  # 不正なインデント（エラー）

実際に実行すると次のようになります。

IndentationError: unindent does not match any outer indentation level

Pythonの記事のまとめ