Python コードコメント

はじめに

コードコメントは、コードが何を目的としているかを理解するのに役立ち、良いコメント習慣は良い開発者にとって欠かせないものです。この実験では、Python 言語にコメントを追加する方法と、いくつかの一般的なコメント方法を学ぶことができます。

達成目標

• コードコメント

1 行コメント

Python では、# が 1 行コメントに使用され、コード行の先頭または末尾に出現することができます。

例

あなたのテキストエディタで /home/labex/project/single.py を開き、1 行コメントを追加します。

## Output hello string
print('hello')

あるいは、コード行の末尾にコメントを置くこともできます。

print('hello') ## Output hello string

1 行コメントは、コード内で説明や明確化を行う際に役立ちます。実行時には無視され、自分自身や他の人にとって有益なドキュメントとして機能します。

複数行コメント

より広範なコメントの場合、Python は複数行コメントに 3 つのシングルクォート ''' または 3 つのダブルクォート """ を使用します。

例

あなたのテキストエディタで /home/labex/project/multi1.py を開き、シングルクォートを使って複数行コメントを追加します。

'''
これはシングルクォートを使った複数行コメントです。
詳細な説明や指示を提供するために使用できます。
'''
name = "Tom"
print("Hello, " + name + "!")

あるいは、テキストエディタで /home/labex/project/multi2.py を開き、ダブルクォートで複数行コメントを追加します。

"""
これはダブルクォートを使った複数行コメントです。
詳細な説明や指示を提供するために使用できます。
"""
name = "Tom"
print("Hello, " + name + "!")

複数行コメントはコードの読みやすさを向上させ、詳細な説明が必要な場合に特に役立ちます。コード内の貴重なドキュメントとして機能します。

まとめ

おめでとうございます！あなたは Python コメントの実験を完了しました。

この実験では、Python の 1 行コメントと複数行コメントを追加する方法を学びました。