【Python】コメントアウト(#)の使い方・書き方

Pythonのコメントの使い方について。

この記事の内容はコチラです

  • Pythonのソースコードにコメントを残す
  • コメントアウトの使い方・書き方を知る

今回は、Pythonでのコメントアウト・コメントの使い方・書き方を解説します。

Python コメントアウト(#)の使い方・書き方

コメントアウトは#をつける

#コメントを書く
myFriend = '山田'
print(myFriend)

Pythonでコメントを書くには、先頭に「#」をつけます。ここでは1行目がコメントになります。

myFriend = '山田'  #コメントを書く 
print(myFriend)

Pythonのコメントは、ソースコードの先頭でなくても構いません。頭に「#」をつけておけば、それ以降がコメントとして扱われます。

コメントの意義

プログラムの補足、タイトル、意味などをソースコードにコメントとして残すことにより、後からこのプログラムを見ても、わかりやすいようにコメントを残しておきます。

特に不特定多数の人が関わるプロジェクトではコメントも重要になってきます。この場合、必要なのは、「自分が読んで理解できるコメント」ではなく、「他人が読んで理解できるコメント」になります。コメントは「自分に向けて」よりも「他人に向けて」なのです。

プログラマーがあまり得意ではない他人目線の考え方です。コメントの書き方にもセンスがとわれますね。

以上、Python でコメントアウト(#)の使い方・書き方の解説でした。

コメント