MENU
やすひら
やすひらと申します。
長靴を履いたタヌキ(ITエンジニア)です。
モノ作りの楽しさを発信中。
X(旧Twitter)のフォローもお願いします。

[Python] コメントの書き方

ソースコードのコメントは、コードの可読性や保守性を向上するために必要です。
Pythonのコメントの書き方について紹介します。

やすひら

Pythonのコメントの書き方を紹介します

この記事でわかること
  • コメントとは
  • Pythonのコメントの書き方
目次

コメントとは

コメントとは、コードに記述する説明文やメモのことです。
コメントを入力しても、プログラムの動作には直接影響せず、ソースコードを読む際の理解度を向上させるのに利用できる機能です。

Pythonのコメントの書き方

本記事では、Pythonを例にコメントの書き方を紹介します。
Pythonでは、#を使用してコメントを記述します。

シングルラインコメント

1行のコメントでコードを説明します。

ソースコード

# ユーザーの名前を入力
name = input("Enter your name: ")

1行ごとにコメントを記入できます。

ブロックコメント

数行にわたる説明が必要な場合は、複数の行にわたってコメントを記述します。

ソースコード

# この部分では、ユーザーの年齢を基に
# 特定のアクションを実行するための条件を設定しています。
# 年齢が18以上の場合、成人向けのメニューを表示します。
if age >= 18:
    show_adult_menu()

文字数の多いコメントを記入できます。

ドキュメンテーションストリング(Docstring)

関数やクラスの説明をする際には、””” “””を使用したドキュメンテーションストリングが便利です。

ソースコード

def calculate_area(radius):
    """
    円の半径を受け取り、面積を計算して返す関数。
    引数:
        radius (float): 円の半径
    戻り値:
        float: 円の面積
    """

return 3.14159 * radius * radius

関数やクラスの概要を記述できます。

Pythonコメント例

Pythonのソースコードのコメント例を紹介します。

ソースコード

class Tanuki:
    """ タヌキクラス: タヌキオブジェクトを実行 """
    def __init__(self, name, age):
        self.name = name # 名前
        self.age = age   # 年齢

    def profile(self):
        """
        自己紹介文を生成する。

        Returns:
            message (str): 自己紹介メッセージ
        """

        # 自己紹介分を生成
        message = f"Hello, I am {self.name}, I am {self.age} years old."

        # TODO: 自己紹介に必要な事項があれば追加していく

        return message

    def greet(self, request):
        """
        挨拶の応答を生成する。

        Args:
            request (str):  リクエスト

        Returns:
            response (str): レスポンス
        """

        # 挨拶の応答を生成
        # 注意事項: LLMによる判定ではないため汎用的な応答はできないの
        if request == "Hello": # こんにちは
            response = "Hello"
        elif request == "Good morning": # おはよう
            response == "Good morning"
        elif request == "Good evening": # こんばんは
            response == "Good evening"
        elif request == "Good night":   # おやすみ
            response == "Good night"
        else: # その他
            response == "Do you need something?"

        return response

yasuhira = Tanuki("yasuhira", 10)
print(yasuhira.profile())
print(yasuhira.greet("Hello"))

Pythonでは、本記事の例のようにコメントを記述します。

まとめ

Pythonにおけるコメントの書き方を紹介しました。

Pythonのコメントは
  • シングルラインコメントで記述できる
  • ブロックコメントで記述できる
  • ドキュメンテーションストリングで記述できる

コメントを適切に記載することは、プログラムの可読性やメンテナンス性を向上させるために重要です。
読みやすいソースコードは、無駄な読み込み時間や調査時間を削減することができるため、生産性向上に役立ちます。
他のエンジニアが読みやすいかを考えながらプログラミングしていくと良いです。

  • URLをコピーしました!
目次