Pythonでは、関数やクラスの定義の先頭にコメントを記述することができます。これらのコメントは、docstring(ドックストリング、ドキュメンテーション文字列)と呼ばれています。docstringは通常のコメントとは異なり、ヘルプとして表示することができ、プログラムのコーディングの際に、関数やクラスの説明として参照して活用することができます。

Pythonのコメントアウトには、行単位のコメントアウトと複数行単位のコメントアウトの2種類があります。行単位のコメントは、#に続けて記述します。#以降は行の終わりまで実行時に無視されます。複数行にまたがるコメントアウト記号はPythonにはありませんが、プログラム中に記述された文字列は実行に影響を及ぼさないため、これを利用してクォーテーションを使って複数行単位のコメントを記述します。具体的には、 ”’ (シングルクォーテーション3つ)あるいは\”\”\”(ダブルクォーテーション3つ)で囲まれた部分がコメントアウトされます。

Pythonのコメントアウトの方法を理解し、適切に使用することで、コードの可読性を向上させることができます。また、docstringを活用することで、関数やクラスの機能を明確に示し、他の開発者がコードを理解しやすくすることができます。

投稿者 admin

コメントを残す

メールアドレスが公開されることはありません。 が付いている欄は必須項目です