コード内のコメント

5.1 コメントを書く方法

Pythonでは、多くのプログラミング言語と同様に、コードにコメントを書くことができるよ。コメントはプログラマーや他のプロジェクト参加者がコードを理解するのを助けてくれる。これは特に共同作業や長期的なメンテナンスで役立つよ。Pythonにはいくつかの方法でコードにコメントを追加できるんだ。

単一行コメント:

# で始まるよ。#の後に続く同じ行のすべてがPythonによって無視される。このタイプのコメントは通常、コードの特定の行についての短いメモや説明に使われるよ。例：

# これは単一行コメント
print("Hello, World!") # 関数の動作についての説明

複数行コメント:

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

# これは複数行コメントの例 # 各行が#で始まる
      

または:

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

5.2 コメントを書く理由

コードにコメントを使うことで、読みやすさが向上し、保守や更新が楽になり、チームでの効率的なコラボレーションが促進されるんだ。コメントは短くても情報豊かで、コードの有用なドキュメントとなり、余計な情報でごちゃごちゃしないようにする必要があるよ。

ドキュメント文字列 (docstrings):

これは通常、モジュール、クラス、メソッド、関数の目的を説明するために冒頭に置かれている文字列だよ。トリプルダブルクォートで囲まれていて、自動的にドキュメントを生成するために使われることもあるんだ。

例：

def add(a, b):
""" 2つの数を足す関数。 :param a: 最初の加数 :param b: 第二の加数 :return: aとbの合計 """
    return a + b

プログラミングの世界では、時折、開発者はコードに笑えるコメントを追加することがあるんだ。これがその一例だよ：

例 1:

 

            # ここで何が起こっているのか説明したいけど、もう自分でもわからない。
        

例 2:

 

    # これが動作しない場合、誰か他の人が悪い。

例 3:

 

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

例 4:

 

    # これを書いたとき、私と神様だけがこれがどう動くかを知っていた。
    # 今は神様しか知らない。

これらのコメントは、開発プロセスに軽やかさとユーモアをもたらし、コードベースを単調にしないようにするんだ。また、ソフトウェア開発は創造的で人間的なプロセスだということを思い出させてくれるね。

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

PyCharmでは、ショートカットキーを使ってコードを素早くコメントアウトしたり、元に戻したりできるんだ。これを行うには、変更したいコード行を選択して、WindowsではCtrl + / (またはmacOSではCmd + /) を押してね。このキーの組み合わせは、選択した各行にコメント記号を追加したり削除したりして、素早く効果的に作業できるようにするよ。