Python でのコメント は、プログラムの実行中にインタープリタによって無視されるコード内の行です。
# I am single line comment> > > ''' Multi-line comment used> print('Python Comments') '''> |
>
1ヶ月は何週間ですか
>
コメントによりコードの読みやすさが向上し、プログラマがコードを注意深く理解するのに役立ちます。コメントを追加するとコードの説明が容易になるため、他の開発者との共同作業にも役立ちます。
Python のコメントの種類
Python には 3 種類のコメントがあります。
- 一行コメント
- 複数行のコメント
- 文字列リテラル
- ドキュメント文字列のコメント
Python でのコメント
この例では、次のことがわかります。 パイソン コメントは、プログラムの実行中にインタープリタによって無視されます。
Python3
# sample comment> name>=> 'geeksforgeeks'> print>(name)> |
>
>
出力：
geeksforgeeks>
Python でコメントが使用されるのはなぜですか?
コメントはプログラミング言語に不可欠な部分であり、言語ごとにコメントの使用方法が異なります。
他の言語と同様に、Python のコメントには次の目的があります。
- コードの可読性の向上
- 他の人にコードを説明する
- しばらくしてから勉強すればコードを理解できる
- 機能の手順とニーズを文書化する
- 他の開発者とコードを共有する
- 複数の人で協力すること。
Python のコメントの種類
さまざまな種類のコメント、その使用方法、いつ使用するかを見てみましょう。
1. 単線 コメント
- Python の 1 行コメントは、空白を含まないハッシュタグ記号 (#) で始まり、行の終わりまで続きます。
- コメントが 1 行を超える場合は、次の行にハッシュタグを付けて Python コメントを続けます。
- Python の 1 行コメントは、変数、関数宣言、式の短い説明を提供するのに役立つことが証明されています。単一行のコメントを示す次のコード スニペットを参照してください。
例：
Python3
# Print techcodeview.com ! to console> print>(>'techcodeview.com'>)> |
>
>出力
techcodeview.com>
2. 複数行のコメント
Python にはオプションがありません 複数行のコメント 。ただし、複数行のコメントを記述する方法はいくつかあります。
a) 複数のハッシュタグ (#) を使用した複数行のコメント
Python では複数のハッシュタグ (#) を使用して複数行のコメントを書くことができます。各行は 1 行のコメントとみなされます。
Python3
# Python program to demonstrate> # multiline comments> print>(>'Multiline comments'>)> |
>
>出力
Multiline comments>
以下もチェックしてください: Python の複数行コメントに関する興味深い事実
int 文字列 Java
3. 文字列リテラル
Python は無視します 文字列リテラル これらは変数に割り当てられていないため、これらの文字列リテラルを Python コメントとして使用できます 。
a) 文字列リテラルを使用した単一行のコメント
上記のコードを実行すると、出力がないことがわかります。そのため、次の文字列を使用します。 三重引用符 () は複数行コメントとして使用できます。
Python3
'This will be ignored by Python'> |
>
>
b) 文字列リテラルを使用した複数行のコメント
Python3
''' Python program to demonstrate> >multiline comments'''> print>(>'Multiline comments'>)> |
>
>出力
Multiline comments>
4. ドキュメント文字列
- Python ドキュメント文字列 関数の直後に表示される三重引用符を含む文字列リテラルです。
- これは、Python モジュール、関数、クラス、メソッドで作成されたドキュメントを関連付けるために使用されます。
- これは、関数、モジュール、またはクラスのすぐ下に追加され、その動作を説明します。 Python では、docstring は __doc__ 属性を介して利用可能になります。
例：
Python3
def> multiply(a, b):> >'''Multiplies the value of a and b'''> >return> a>*>b> > > # Print the docstring of multiply function> print>(multiply.__doc__)> |
>
>
出力：
Multiplies the value of a and b>
Python のコメントの利点
コメントは通常、次の目的で使用されます。
- コードの可読性
- プロジェクトのコードまたはメタデータの説明
- コードの実行を阻止する
- リソースを含めるには
コメントの正しい書き方
コメントはコードを説明することが主な目的です。開発者は、コードをより深く理解するために、健全なコメントの書き方を実践します。
コメントを効果的にするためのヒントとしては、次のようなものがあります。
- コメントは短く、正確である必要があります。
- コメントは必要な場合にのみ使用し、コードをコメントで乱雑にしないでください。
- コメントには何らかの意味があるはずです。
- 一般的なコメントや基本的なコメントは書かないでください。
- 一目瞭然のコメントを書きます。
Python のコメント、Python のコメントの書き方、コメントの種類、その利点とコメントの正しい書き方についてすべて説明してきました。
こちらもお読みください: Python3でコメントを書くにはどうすればよいですか?