Pythonでコメント、docstringを入力する方法/#の使い方

IT

基本的にPythonでコメントを入力する場合、#の後に文字を入力すればOKです。
関数やクラスの説明を記入するdocstringについても言及します。

スポンサーリンク

Pythonでコメントを入力する方法

python コメント1
まずShellウィンドウ(対話モード)で試しますが、このように#の後に入力した内容はコメントとして色が変わり(Idleなどのエディタの場合)、コード上は無視されます。
python コメント2
コードや戻り値と色分けされていることが確認できます。
#python
#comment
print("hello world")
Editorウィンドウの場合も、同様に#の後ろに文字を置くことでコメント化することができます。
python コメント3
実行しても動作には影響しないので、内容の説明やメモ書きに使用することができます。

docstring

python docstring1
defで関数を自作した際、何にも結び付かない文字列を入れても処理上は問題なく動き、かつ文字列は無視されます。
python docstring2
その後に有効な処理を置けば、文字列を無視して処理だけが実行されます。
python docstring3
つまり、この文字列部分に関数の説明を書いてやれば、実質コメントとして機能するというわけです。クラスの場合も同様。
この関数やクラスの説明部分をdocstringといいます。可読性を上げる意味で、使い捨て以外のプログラムでは書くことが推奨されます。特に他の人も読むコードでは必須です(ただし、うちのサイトでは説明が煩雑になるので基本省略します)。
#python
def abc(x,y):
    """
    Returns x * y
    param x:int width
    param y:int height
    """
    print(x * y)
    
abc(10,20)
必要なのは関数の内容、変数の意味です。”をみっつつなげて閉じると複数行文字列を書けるという意味になります。
120%母国語圏の人間しか読まない場合を除き、コメントやdocstringは英語が推奨されます。
Python操作方法、関数・メソッドリファレンス
なかなか落ち着いて勉強する時間がとれずにいますが、自分を追い込む意味もこめてPythonまとめページです。 そのうち多分きっと充実してくることでしょう……。 初期準備、基本概念 ダウンロード、インストール、起動 ShellとEdit...

コメント