python - Pythonでコマンドにコメントする正しい方法

Question

Python でコメントを残す 2 つの方法を知っています。1 つは使用して"""おり、もう1 つは を使用してい#ます。最初のものを使用して、関数のヘルプを利点として返すことができることを知っています。しかし、いつ一方を使用し、いつ他方を使用する必要がありますか? また、どうすればコメントを残すことができますか? Tab キーを押して、コメントの最初の行とその下のコマンドを配置する必要がありますか? または、行の先頭から開始する必要がありますか?

Answer 1

いいえ、以下を使用してコメントする方法は1 つ#しかありません。

コメントは、文字列リテラルの一部ではないハッシュ文字 (#) で始まり、物理行の終わりで終わります。

トリプル クォーテーション"""は文字列オブジェクトを作成し、それが関数、モジュール、またはクラスの最初の行である場合に docstring として使用されます。トリプル クォーテーションは他の多くの場所でも役立ちますが、コメントと混同しないでください。他の文字列リテラルと同じように三重引用符で囲まれた文字列を使用できますが、\nエスケープ文字を使用する代わりに、ソース コードで実際の改行を使用できるという特定の利点があります。

代わりに複数行の文字列に変換することでコードのブロックを無効にするために使用できますが、実際にはこれを行うべきではありません。適切なソース コード管理を使用して、単にブロックを削除するか、代わりに挿入してブロック全体をコメント アウトできるエディターを使用します#。

実際のコメントについては、 を使用します#。Python スタイル ガイド (PEP 8)には、コメントをいつ、どのように使用するかについて、いくつかの説明があります。インデントについて次のように述べています。

ブロック コメントは通常、その後に続く一部 (またはすべて) のコードに適用され、そのコードと同じレベルにインデントされます。ブロック コメントの各行は、# と 1 つのスペースで始まります (コメント内のテキストがインデントされていない場合)。