Pythonでは、コードの可読性を向上させるために、コメントと関数の説明(docstring)を適切に記述することが推奨されています。
Pythonのコメントとは
Pythonのコメントは、コード内で#
を入れることでそれ以降がコメントとなり、コード実行時に無視されます。
# これはコメントです
Pythonのdocstringとは
一方、Pythonのdocstringは、"""
で囲むことでコメントとなります。docstringは通常のコメントとは異なり、ヘルプとして表示することができ、プログラムのコーディングの際に、関数やクラスの説明として参照して活用することができます。
def example_function():
"""これはdocstringです"""
pass
docstringの利点
docstringを記述することで、後で見直したときにすぐに内容が把握できます。また、Jupyterなどの環境では、関数を呼び出す際にdocstringを表示してくれるため、関数の内容を確認しながらコーディングすることが可能です。
docstringの書き方
docstringの書き方にはいくつかのスタイルがありますが、ここではNumPyスタイルの書き方を紹介します。
def example_function(param1, param2):
"""
関数の説明を記述します。
Parameters
----------
param1 : type
param1の説明
param2 : type
param2の説明
Returns
-------
type
戻り値の説明
"""
pass
このように、Pythonのコメントとdocstringを適切に使用することで、コードの可読性を向上させることができます。