Pythonでコメントアウトする方法

面倒な作業

この記事ではPythonでコメントアウトする方法について解説します。

そして、利用しているのはJupyter Notebookです。
Jupyter Notebookならブラウザ上で簡単にPythonの勉強ができますよ。

もしJupyter Notebookを使ってみたいと感じた場合には
先にAnacondaをインストールして
Anacondaをwindows7にインストールする方法

次にこちらの記事をご覧ください。
Jupyter Notebookの使い方

スポンサードリンク




【Python入門】コメントアウトとは?

コメントアウトは別にPythonだけに限った話ではありません。
PHPにもHTMLにもどんなものにもコメントアウトは存在します。

コメントアウトとはあなたが記述した文をプログラムだと
コンピューター上で認識されないようにすることをいいます。

Pythonでは左端に『#』をつけることで
#より右側にある文字はコメントだとして
無視されます。

たとえば、こんなのがあったとしますね。

# print('私を無視しないで!')
print('どうせ無視するんでしょ!')

実行すると、こうなります。

コメントアウト

こんな感じで#をつけた右側の文は完全に無視されます。
こういうことをコメントアウトと言うわけですね。

ちなみに『#』の後に半角スペースを入れても入れなくても
問題なくコメントアウトできます

ただ、半角スペースを入れておいた方が
あとあとになって、見やすいと思いますよ。

# どうでもいいかもしれませんが
#半角スペースが入ってた方が見やすくないですか?

半角スペースが入っている方が
コメントアウトとして認識しやすいですし
見やすくないでしょうか?

スポンサードリンク




【Python入門】コメントアウトを使う目的

ではコメントアウトってどんな時に使うのでしょう?

コメントアウトの目的1.周辺でやっていることがわかる

コメントアウトをつける目的の一つに
そのコードが何を表しているか
わかるようにするってことがあります。

他人が書いた2~3行程度の簡単なコードなら
そのコードが何を表しているか
すぐにわかるでしょう。

でも他人が書いたコードが100とか200行くらいになると
たとえば35行目のコードが何を表しているとか
すぐに判断することは難しいです。

もちろん自分で書いたコードだって
「あれ、ここは何を書いてたんだっけ?」
となるかもしれません。

そんなとき、コメントアウトでたとえば

# ここはテスト
print(1 + 2 + 5)

としておけば、「ここはテストなんだな」
とか後で見返しても一瞬で把握できるわけですね。

コメントアウトの目的2.バグ修正

たとえば、

print('あああ'あ)

こんなのでミスする人はいないと思いますが
もしわからないとして、上記を実行したとします。

すると当然エラーが出ます。

コメントアウト

ちなみにエラーが出る原因は
‘あああ’あと最後の『あ』が”で囲まれていないからです。

print文について詳しく知りたい方は
コチラの記事をご覧ください。

こちらの記事も。

ここではエラー原因がわからないとして
でも、とりあえず先に進めないと納期がある場合、
エラー部分をコメントアウトします。

こんな感じで。

#print('あああ'あ)

そして、「あ、そういえば、最後の『あ』が”で囲まれていないからかも」
と思った時に、コメントアウトしておいたところに戻り
エラー部分を修正するわけですね。

print('ああああ')

こんな感じでエラーが出たら、
エラー箇所をコメントアウトしておきましょう。
ミスに気付いた時に、修正するだけですみます。

でもコメントアウトせずに、エラー部分を削除してしまったら
再度、コードを書かないといけません。

面倒くさいです。
難しい表現だと、思い出せないかもしれません。

コメントアウトって大事なんですね。

スポンサードリンク




Python以外のコメントアウト

HTMLのコメントアウト

このブログもHTMLで作成されています。
ホームページ必須ですね。

HTMLのコメントアウトはこんな感じです。

<!-- HTMLのコメントアウトです。 -->

』までの間がコメントアウトとして認識されます。
Pythonのコメントアウトは左端に『#』をつけるだけだったので
かなり違いますね。

CSSのコメントアウト

CSSはこのブログで、文字の色を指定したり
背景を指定したり、主にホームページの装飾に使います。

CSSのコメントアウトはHTMLのコメントアウトと違います。

CSSの場合には

/* CSSのコメントアウトはこんな感じ */

と、左端に『/* 』をつけて『 */』で終わるようにします。
CSSもHTMLと同様に、コメントアウトしたい部分を両端で囲むんですね。
やはりPythonのコメントアウトと違います。

PHPのコメントアウト

PHPもホームページ上でよく使われますね。
HTMLと違うのは、PHPだとメールを送受信する仕組みを作れたり
ブログのコメントなんかとして双方向でやりとりができるところですね。

HTMLは一方通行、片思いって感じですけど
PHPだと両想いって感じですかね。

PHPのコメントアウトは

// PHPのコメントアウト
# Pythonと同じコメントアウトも利用できる

です。

PHPの場合、Pythonと同じ『#』でコメントアウトができます。

2行、3行と複数行にまたがる場合には

/*
 何行でも
コメントアウトが
できちゃいますよ。
*/

こんな感じで『/*』に始まり『*/』で
終わることで実現できますよ。

JavaScriptのコメントアウト

JavaScriptはホームページ上なんかで動きを出したいときに
よく使います。

画像をアニメーションにしたりとか。
あとは、時間を表示したいときにも使ったりしますね。

JavaScriptのコメントアウトは

// みんなコメントアウトの仕方が違いますね。

と言った感じで『//』とスラッシュ2つで表現します。

複数行にまたがるときには

/*
PHPのコメントアウトと
複数行の場合、同じですね。
そう思いませんか?
*/

とPHPのコメントアウトのやり方と同じになります。

Javaのコメントアウト

JavaのコメントアウトもPythonと違います。

// Javaのコメントアウトはこうです。

Javaのコメントアウトは『//』スラッシュ2つつけます。

複数行にまたがる場合には

/*
Javaの複数行コメントは
PHPなどと同じですね。
似ているところもあれば
違うところもあるわけですね。
*/

と『/*』に始まり『*/』で終わります。

C言語でのコメントアウト

C言語でのコメントアウトは
こんな感じになります。

/* C言語では一行コメントでも両端で囲まないといけないんですよ */

C言語だと一行コメントも複数行コメントみたいに
最初から最後まで囲まないといけないんですね。

Pythonと比べて少し面倒かもしれませんね。

それから

/*
複数行でも
C言語は同じように
やらないといけません。
*/

C言語の場合には一行でも複数行でも
同じような方法でコメントアウトすることになります。

そういった意味では、間違いにくいので
ミスは減るかもしれませんね。



Pythonでのコメントアウトまとめ

どんな言語にもコメントアウトはあります。
ただ、言語によって違います。

Pythonの場合には

# 半角スペースを開けてもいいし
#半角スペースを開けなくても大丈夫です。

と『#』を左端につけることでコメントアウトすることができます。

『#』のあと、半角スペースをつけてもつけなくても
問題なくコメントアウトになります。

以上でPythonにおけるコメントアウトに関する解説を終わります。

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

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

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

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

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

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

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

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

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


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

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

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

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

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


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

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

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

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

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

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

関連記事

ページ上部へ戻る