【Python入門】コメントとは？方法も解説【初心者必見】
コメントの使い方に悩んでいる人「コメントって何？Pythonではどうやってコメントをするの？」
こういった疑問に答えます。
本記事でわかること
- コメントとは何か
- Pythonのコメントの方法
- コメントの際の注意点3つ
【Python入門】コメントとは？【方法解説】
コメントとは何か
コメントとはソースコードに直接記述する解説文のことです。
ソースコードには通常は英語しか書かれていませんがコメントを用いることで、日本語でコードの解説文を記述できます。コメントで解説文を付け加えるとソースコードが見やすくなります。以下のようなイメージです。
【コメントなし】
print("hello")
print("good")
print("bad")【コメントあり】
下の命令文は「hello」を出力する
print("hello")
下の命令文は「good」を出力する
print("good")
下の命令文は「bad」を出力する
print("bad")上記のイメージのようにソースコードに解説文を入力すると後から振り返った時や他の人が見たときに何のコードが書かれているか理解しやすいです。
上記のソースコードはイメージです。実際にコメント(解説文の日本語)を入力するためにはあることをしなくちゃいけません。その方法について学んでいきましょう。
Pythonのコメントの方法
Pythonのコメントの方法は大きく分けて2つあります。
- 一行のコメントをを書く方法
- 複数行のコメントを書く方法
1行のコメントを書く方法
1行のコメントを書く時は「#(シャープ)」を使います。具体的な使い方は以下を参考にしてください。
#このようにシャープを使うとコメントを使うことができます。【サンプルコード】
#このようにシャープを使うとコメントを使うことができます。
print("hello")【実行結果】
hello【サンプルコード】
print("hello")#このように後ろでも使えます。【実行結果】
hello
次は複数の文のコメントを書く方法についてです。もちろん#(シャープ)を用いて書くこともできます。しかしそれでは何度も#(シャープ)を用いるのはめんどくさいですよね。そんな方のために簡単に複数のコメントを記述する方法を紹介します。
複数のコメントを書く方法
複数のコメントを記述する方法は2つあります。1つはダブルクォテーションを用いる方法です。以下のように記述します
"""
こちらはコメントです。
こちらはコメントです。
こちらはコメントです。
こちらはコメントです。
"""もう一つはシングルクォーテーションを用いる方法です。使い方は先ほどと同じです。
'''
こちらはコメントです。
こちらはコメントです。
こちらはコメントです。
こちらはコメントです。
'''【サンプルコード】
"""
こちらはコメントです。
こちらはコメントです。
こちらはコメントです。
こちらはコメントです。
"""
print("hello")【実行結果】
hello【サンプルコード】
'''
こちらはコメントです。
こちらはコメントです。
こちらはコメントです。
こちらはコメントです。
'''
print("hello")【実行結果】
hello
上記のようにダブルクォテーションやシングルクォーテーションを用いると複数行のコメントを記述することができます。
ここまでが、コメントを書く方法です。簡単ですよね。しかしコメントを書いたことによってプログラムがエラーになることもあります。そんなことは避けたいですよね。
今からコメントを書く際の注意点2つを紹介します。
コメントの際の注意点2つ
- インデントが揃っていない
- コードの前にコメントを記述
インデントが揃っていない
インデントが揃っていないとは以下のようなことです。
"""
aiueo
aiueo
"""
print("hello") """
aiueo
aiueo
"""
print("hello")このように始まる位置が違うと正しくコメントだと認識してくれません。
正しくは以下のように書く必要があります。
"""
aiueo
aiueo
"""
print("hello")
コードの前にコメントを記述
【ダメな例】
#こちらはコメントです。print(hello)【いい例】
print(hello)#こちらはコメントです。こんな間違えをする人がいるのか？と思ってしまいますが、意外に多くいます。コメントをコードの前に記述するとコードもコメントの1つだと認識されますので気をつけてください。
まとめ
今回はコメントについて解説していきました。コメントとはソースコードに記述する解説文のことです。コメントを記述する方法は1行のコメントを書くか複数行のコメントを書くかで異なります。
・1行のコメントを書く場合は#(シャープ)を使います。
・複数行のコメントを書く場合は”””(ダブルクォテーション)や”'(シングルクォーテーション)を使います。
注意点は2つあり、インデントを揃えることとコードの前にコメントを書かないことだけは気をつけましょう。
今回は以上になります。最後までご覧いただきありがとうございました。