Pythonのコメント

1. コメントを書く方法

Pythonでは、他の多くのプログラミング言語と同様に、コード内にコメントを書くことができるよ。

コメントって、ただ他のプログラマーに向けたテキストなんだ。 Pythonインタプリタはコメントを無視して、そこに書かれたコードも実行しない。コメントはプログラマーやプロジェクトの他のメンバーがコードを理解するのを助けてくれる。 特に共同作業や長期的なメンテナンスで役立つんだよね。Pythonではコードにコメントを追加するいくつかの方法があるんだ。

一行コメント:

# 記号で始めるんだ。# の後にある同じ行のすべてをPythonインタプリタは無視する。 このタイプのコメントは、特定のコード行に対する簡単な説明や注釈を書くのに使われることが多いよ。例を見てみよう：

# これは一行コメントだよ
print("こんにちは、世界！")  # 関数の動作の説明

複数行コメント:

実は、Pythonには複数行コメント専用の構文はないんだけど、複数の一行コメントを使って作成したり、 トリプルクオートを使うことでできるんだ。後者は実際にはコードとして実行されない複数行の文字列リテラルなんだ。 例を見てみよう：

# これは複数行コメントの例だよ
# 各行が`#`記号で始まっている

あるいは:

"""
これが複数行のリテラルで、コメントとして使えるんだ。
Pythonはこれを文字列として解釈するけど、変数に代入したり式で使わない限り何もしないよ。
"""

役立つ情報！ リテラルとは、コード上に直接記述された小さなデータのことだよ。数値、文字列とかね。

2. コメントを書く理由

コメントをコードに使うことで、コードの可読性が向上し、保守や更新がスムーズになり、チームでのコラボレーションも効率的になるんだ。 コメントは短くても情報量があって、今の状況にマッチしてることが大事！そうすることで、コードのドキュメントとして役立つし、 無駄な情報でコードを埋め尽くすことも避けられる。

ドキュメンテーション用文字列 (docstrings):

これは通常、モジュール、クラス、メソッド、関数の先頭に置かれる複数行の文字列で、それらの目的を説明するために使われるんだ。 トリプルクオートで囲われていて、自動生成されるドキュメントに活用されるよ。

例:

def add(a, b):
    """
    2つの数を足し合わせるための関数だよ。
    :param a: 第1の項
    :param b: 第2の項
    :return: aとbの合計
    """
    return a + b

プログラミングの世界では、コードに説明を加えるだけでなく、ちょっと笑えるコメントを追加する開発者もいるんだ。 こんな面白いコメントの例を見てみよう：

例 1:

# ここで何が起きているか説明しようかと思ったけど、自分でも分かんなくなった。

例 2:

# これが動かないとしたら、誰か他の人のせいだ。

例 3:

# 来た、見た、直した...そして壊した。

例 4:

# これを書いた時、オレと神だけがどう動くか知ってた。
# 今は神だけが知ってる。

例 5:

# ここで無駄にした時間の合計 = 42時間。

こういうコメントは開発作業にちょっとした軽さやユーモアを持ち込んでくれる。 また、ソフトウェア開発が創造的で人間味のあるプロセスであることを思い出させてくれるんだ。

5.3 コードを素早くコメントアウトする方法

PyCharm IDEでは、ショートカットキーを使ってコードを素早くコメントアウトしたりアンコメントしたりできるんだ。 コメントアウトしたいまたはアンコメントしたいコード行を選択して、 WindowsならCtrl + / (macOSならCmd + /) を押してみて。 このキーの組み合わせは、選択された各行にコメント記号を追加または削除してくれるから、速くて効率的だよ。