Pythonや他のプログラミング言語で記述する際、プログラムだけを記述していると、他の人がみたときに一目ではそのプログラムが「何をするプログラムなのか」が分かりません。
また、時が経って自分の書いたプログラムを見返したときにも、「何を書いているか」が分からなくなることが多いです。
そこで使用するのがコメントアウト。
コメントアウトを使用することで、日本語や英語などでメモのような補足説明をプログラム内に記述することができます。
本記事では、Pythonにおけるコメントアウトの書き方と使用例を紹介します。
Pythonプログラミングの基本ですので、確実に押さえておきましょう！
AIやデータサイエンスを学びたくてPythonを学び始めたけど
「独学ではやっぱり限界がある」
と不安を感じた方にオススメしたいのが、Aidemy Premium Plan。
AIに関する幅広い種類の講座や徹底したコーチング指導が特徴です！
実務を見据えてPythonをがっつり学習していきたい方は、まずは無料の「オンライン相談」に参加してみてください。
また、Aidemy Premium Planのメリットやデメリットなどについては、以下の記事も参考にしてください。
Aidemy(アイデミー)の評判と口コミまとめ！受講したほうがいい理由を紹介
Pythonにおけるコメントアウトは「#」か「”’」
Pythonでコメントアウトをする際は、「#」か「”’」を用います。
「#」の使用｜1行・行中のコメントアウト
「#」を使用することで、1行全体、または行の途中からコメントアウトをすることができます。
つまり「#」以降の文字は、プログラム実行の際には無視されるということです。
1行全体のコメントアウト例
[code language=”python”]#リストの定義
height = [166, 171, 176, 168, 172]
#[171,176]を表す
height[1:3]
#[166, 171, 176, 168]を表す
height[0:4][/code]
「#」行には、プログラムの説明を記述しています。
「#」なしで記述してしまうと、Pythonエラーが表示されます。
1行全体のコメントアウト例
[code language=”python”]height = [166, 171, 176, 168, 172] # リストの定義
height[1:3] # [171,176]を表す
height[0:4] # [166, 171, 176, 168]を表す[/code]
各行の「#」以降の部分は、プログラムの説明です。
こちらも、「#」なしで記述してしまうと、Pythonエラーがが表示されてしまいます。
「”’」の使用｜複数行のコメントアウト
「”’」で該当箇所を囲むことで、複数行のコメントアウトをすることができます。
すなわち「”’」で囲まれた文字は、プログラム実行の際には無視されるということです。
「”’」を用いたコメントアウトは、Docstrings (Documentation sstrings) といいます。
複数行のコメントアウト例
[code language=”python”]height = [166, 171, 176, 168, 172] # リストの定義
”’
上記のリストは
ある男性アイドルグループの
メンバーの身長
”’
height[1:3] # [171,176]を表す
height[0:4] # [166, 171, 176, 168]を表す[/code]
「”’」で囲まれた部分は、プログラムの説明です。
「”’」なしで記述してしまうと、Pythonエラーがが表示されてしまいます。
「”’」でコメントアウトする際の注意点
「”’」を用いてコメントアウトをする際は、直前の行と同じインデントで記述しなければなりません。
例えば、
[code language=”python”]height = [166, 171, 176, 168, 172] # リストの定義
”’
上記のリストは
ある男性アイドルグループの
メンバーの身長
”’
height[1:3] # [171,176]を表す
height[0:4] # [166, 171, 176, 168]を表す[/code]
としてしまうとエラーが出てしまうので、注意しましょう。
PythonのコメントアウトはPEP8も参照しよう
PEP8とは、Pythonのコードスタイルガイドラインです。
必ずしもPEP8に従わなくてわならない、という訳ではありませんが、参考にすることでより一般的なコードを書けるようになります。
ここでは、PEP8に書かれている内容から要点を抜粋します。
「#」を用いたコメントアウトはスペースを入れる
start with a # and a single space
とあるように、「#」と次から始まる文字の間に、半角スペースを入れると良いでしょう。
[code language=”python”]# 推奨のコメント
#非推奨のコメント[/code]
行中コメントアウトは半角スペースを2つ以上あける
Inline comments should be separated by at least two spaces from the statement.
とあるように、行中のコメントアウトでは、プログラムとコメントアウトの間に最低でも2つの半角スペースを入れると良いでしょう。
[code language=”python”]a = 1 # 推奨のコメント
b = 2 # 非推奨のコメント[/code]
最後に: Pythonのコメントアウトは基本なので、書き方を覚えよう！
Pythonのコメントアウトは、サンプルコードをみる際にも多分に出てきます。
それぞれの記述方法を理解して、自分でも使えるようにしましょう。
