【Python入門】複数行にわたるコメントを効率的に記述する方法

※アフィリエイト広告を利用しています

python リスト内包表記

どんなプログラミング言語でもそうですが
Pythonでもコメントを書くことができます。

さっそくですが例題1をご覧ください。

#例題1
x = 'こんばんは'
print(x)

例題1では『こんばんは』という文字列を
変数xに代入しています。

そして『こんばんは』という文字列が入った変数xを
print文で表示させています。

実行すると
こんばんは
と表示されます。

コメント

ここで、変数xに代入とか文字列という用語が出てきました。
詳しく知りたい方は以下の記事をご覧ください。
python特有の文字列操作まとめ
【Python入門】変数の代入についてわかりやすく解説

では、例題2でコメントを入れていきましょう。
そのあとに、複数行にわたるコメントを入れる方法について解説していきますね。

スポンサードリンク




【Python入門】コメント行を入れてみよう

まず1行レベルのコメントを入れてみましょう。

例題2をご覧ください。

#例題2
print('こんばんは')
# print('おはようさん')
print('こんにちは')

実行すると
こんばんは
こんにちは
と表示されます。

コメント

ここでいいたいのは

# print('おはようさん')

です。

こんな感じで#をつけたら、
そのあとの文字は完全に無視されます。
これがコメントですね。

だから

#例題2
print('こんばんは')
# print('おはようさん')
print('こんにちは')

と記述しても

# print('おはようさん')

の部分が無視されて、

コメント

と表示されるわけです。

では次に効率よく複数行のコメントを書く方法について解説していきます。

スポンサードリンク




【Python入門】複数行にわたるコメントを効率的に書く方法

例題3をご覧ください。

#例題3
print('こんばんは')
# print('おはようさん')
# コメント書いてます。
# さらにコメント書いてます。
#くどいくらいコメント書いてます。
print('こんにちは')

複数行にわたるコメントを書く基本は上記のような感じです。

1行ごとに#をつけてコメントを書いていくわけです。
ただ、この方法は面倒くさいです。

ではどうすればよいでしょう?

例題4をご覧ください。

#例題4
print('こんばんは')

"""
こんな感じで
"(ダブルクオーテーション)3つで
上下囲むことで、その間の文字や数は
コメントとして無視されるようになります。

"""
print('こんにちは')

例題4で大事なのは

"""
こんな感じで
"(ダブルクオーテーション)3つで
上下囲むことで、その間の文字や数は
コメントとして無視されるようになります。

"""

"""

です。

こんな感じで“(ダブルクオーテーション)を3つつけて
上下囲むことで、その間の複数行はコメントとして
完全に無視
されます。

もちろん、1行ごとに#をつける必要がありません。

これで効率的に複数行にわたってコメントを書くことができますね。

スポンサードリンク




【Python入門】どんな時にコメントを使うの?

例題5をご覧ください。

#例題5

# 以下は6年2組の身長データです。
x = 125

"""
コードの右側に書かずに
説明したいコードの上にコメントを書くのが
暗黙の了解です。

"""

y = 185 # こんな感じでコードの右側にコメントを書いてもOK

print(x)
print(y)

実行すると

複数行のコメント

となります。

コメントは

# 以下は6年2組の身長データです。
x = 125

みたいな感じで、変数xがどんな値なのか
誰がみてもわかるように記載
します。

それからコメントは

# 以下は6年2組の身長データです。
x = 125

みたいに、コードの上に書いてもいいですし、

y = 185 # こんな感じでコードの右側にコメントを書いてもOK

みたいにコードの横に書いても大丈夫です。

ただ、Pythonの世界では

# 以下は6年2組の身長データです。
x = 125

みたいに、コードの上に書くのが一般的です。
暗黙の了解になっています。

pythonを学ぶならこちらの動画講座がおすすめです

Python 3 入門 + 応用 +アメリカのシリコンバレー流コードスタイルを学び、実践的なアプリ開発の準備をする

かなり長い講座名ですね。
わかりにくそうな感じがします。

ですが、pythonの基礎からしっかりとわかりやすく教えてくれます。

また、きれいなコードを書くための方法についても
教えてくれるので、周りが「どうやってそんなコードを書いてるの?」
とびっくりされるようになるかもしれません。

それからWebアプリケーション開発の基本的なテクニックについても
教えてくれます。

なので、pythonを使ってwebアプリケーションを作ってみようと
思っている方にもおすすめです。

値段は時期によって違います。

詳しくはこちらをご覧ください。


みんなのAI講座 ゼロからPythonで学ぶ人工知能と機械学習

この講座ではまずpythonの基礎を学びます。
次に人工知能について学んでいきます。

そして最終的にはpythonを使って文字認識や株価分析ができるような技術力が身につくようになっています。

単純に教科書的なpythonを学ぶのではなく
仕事でも使えるスキルを身につけたい方におすすめの講座です。

なのに値段は恐ろしいほど安いです。
時期によって値段は変動するので
詳しくはこちらをご覧ください。


Pythonで機械学習:scikit-learnで学ぶ識別入門

この動画講座は広島大学准教授の先生が担当しています。
機械学習が専門の先生です。

すごく深い知識が身につきます。
大学の先生の講義って難しそうってイメージがあるかもしれません。

でもそんなことはありません。
すごくわかりやすいです。

pythonで機械学習のスキルを身につけたい方におすすめです。
値段は時期によって違いますが、かなり、良心的な価格になっています。

詳しくはこちらをご覧ください。

関連記事

ページ上部へ戻る