Pythonのコメントの書き方（1行・複数行・docstring）

今回はPythonのコメントの書き方について学習しましょう。
1行、複数行のコメント、docstringについて実際のサンプルコードもあわせて紹介します。

今回はPythonのコメントの書き方ついてお勉強しよう！

Pythonのコメントの書き方

Pythonにおいて、コメントを記述することは、コードの可読性を高める上で非常に重要です。
コメントを利用することで、自分や他の開発者がコードを理解しやすくなります。

また、デバックに用いたコードを無効化する目的としても使用されます。

1行コメントの書き方

1行コメントは、行の先頭に #（シャープ）を付けることで記述できます。
行の先頭に記述するコメントはブロックコメントと呼ばれます。

# この行はコメントです。

文中に#を用いると、#からその行の終わりまでを無効化できます。
行中に記述するコメントはインラインコメントと呼ばれます。

print("test")　# シャープ以降がコメントです。

複数行コメントの書き方

複数行コメントは、シングルクォーテーション３つまたは ダブルクォーテーション３つで囲むことで記述できます。
シングルクォーテーション３つまたはダブルクォーテーション３つの間がコメントとして扱われます。

シングルクォーテーションを用いたコメントの例

'''
これは
複数行
コメントです。
'''

ダブルクォーテーションを用いたコメントの例

"""
これは
複数行
コメントです。
"""

docstringの書き方

ドキュメンテーションストリングス（docstring）とは関数やクラスの説明文のことです。
docstringを用いることで関数やクラスをわかりやすく説明することができます。

docstringを1行で記述する方法

docstringを一行で書く場合、関数やクラスの一行目に簡潔に説明を記述します。

def func(x, y):
    """関数の簡単な説明"""
    関数の中身

def class(x, y):
    """クラスの簡単な説明"""
    クラスのコード

例えば足し算を行う関数の場合、次のように記載します。

def add_func(x, y):
    """引数 x, y に対して、x + y を返す関数"""
    return x + y

docstringを複数行で記述する方法

docstringを複数行で書く場合、関数やクラスの一行目に簡潔に説明を記述し、空行を挟んで詳細な説明を記載します。

docstringには次の内容を記載しましょう。

• 関数やクラスの概要
• 引数の説明
• 戻り値の説明
• 発生する例外

def func(x, y):
    """関数の簡単な説明
    
    詳細な説明はここに書く。
    引数の説明
    戻り値の説明
    例外の説明
    等
    """
    関数のコード

例えば足し算を行う関数の場合、次のように記載します。

def add_func(x, y):
    """引数 x, y に対して、x + y を返す関数
    
    Parameters:
    x: int
    y: int
    
    Returns:
    int x + y
    
    Raises:
    ValueError:
    引数xやyが不正な値の場合
    """
    return x + y

Pythonで日本語のコメントを書く方法

Pythonでは、日本語等、マルチバイト文字が含まれていた場合にはエラーが発生します。
エラーを解消するには文字コードをASCIIからUTF-8に変更する必要があります。

文字コードを変更するには以下のコードをプログラムの1行目に記述しましょう。

# -*- coding: utf-8 -*-

まとめ

今回はPythonのコメントの書き方について学習してみました。
Pythonにおいて、コメントを記述することは、コードの可読性を高める上で非常に重要です。
皆さんもやってみてください。

今回はPythonのコメントの書き方についてお勉強したよ！