Pythonでコメントを記述する

宮崎智広 この記事の監修：宮崎智広（Linux実務・教育歴20年以上・受講者3,100名超）
ＨＯＭＥ ＞ Linux技術 リナックスマスター.JP（Linuxマスター.JP） ＞ Python ＞ Pythonでコメントを記述する
コメントとは、プログラムや設定ファイルを作成、編集した時に
作業内容や日付、作業した人物などをメモとして記述する場合に使用します。
後から見直した時や第三者が内容を見た時に、
状況や内容を把握しやすくするために使用されます。

※しかしたまに、コメントと実際の処理内容、設定内容が異なる場合があります。
　それを見落とすとトラブルの元になりますので、
　コメントのメンテナンスもしっかりやりましょう。
プログラムにしてもLinuxの設定ファイルにしても、

コメントして記述した箇所はシステム的に無視されるので
システムに影響しません。

Pythonでコメントを記述する

Pythonでコメントするには、「#」を使用します。 #以降から行末までがコメントとなり、システム的に無視されます。

#以降がコメントとしてシステム的に無視されます。



「このままじゃマズい」と感じていませんか？
参考書を開く気力もない、同年代に取り残される不安——
でも安心してください。プロのエンジニアはコマンドを暗記していません。
「現場で使える型」を効率よく使いこなしているだけです。
図解60P／登録10秒／解除も3秒 ／ 詳細はこちら

Pythonでコメントを記述する実例

それでは、Pythonでコメントを書く場合の記述例を紹介します。
下記赤字の部分がコメントになり、システム的に無視される部分になります。

#=========================================
# PG Name :コメントの記述例
# Description : Pythonでコメントを記述する実例紹介
# Change His. : 2020.04.09
# Owner Dept. : EnetMercury .Inc
#
#=========================================
#値設定
num1 = 10
num2 = 20

#計算実行
num3 = num1 + num2

#結果を出力
print (num3)


Pythonでコメント出来ない例

どんな場合でも#をつければコメントできるという訳ではありません。
長文を任意のところで改行し、複数行の入力を1行として扱う
「¥」または「\」がある場合、#を記述することはできません。
これもLinuxの仕様と同じですね。

#=========================================
# PG Name :コメントの記述例
# Description : Pythonでコメントを記述する実例紹介
# Change His. : 2020.04.09
# Owner Dept. : EnetMercury .Inc
#
#=========================================
#値設定
num1 = 10 + 11 +12 +13 + 14 \ #ここにコメントは記述できません。
+ 15 + 16

#結果を出力
print (num1)


コメント化することで処理をさせない

コメントはメモを残す場面で使用することが多いですが、
処理を飛ばす、実行させない、プログラム修正をして
その履歴として変更前の状態をあえて残したいという場合にも利用します。

例えば、下の例のように使用します。
この例の場合、「num2 = 20」は無視されて、
「num2 = 30」が有効になります。

#=========================================
# PG Name :コメントの記述例
# Description : Pythonでコメントを記述する実例紹介
# Change His. : 2020.04.09
# Owner Dept. : EnetMercury .Inc
#
#=========================================
#値設定
num1 = 10
#2020.04.09 仕様変更により、設定値を変更
#num2 = 20
num2 = 30

#計算実行
num3 = num1 + num2

#結果を出力
print (num3)

関連記事

無料メルマガで学習を続ける

Linuxの実践スキルをメールで毎週お届け。
登録は1分、解除もいつでも可。

登録無料・いつでも解除できます

暗記不要・1時間後にはサーバーが動く

3,100名以上が実践した「型」を無料で公開中

プロのエンジニアはコマンドを暗記していません。
「現場で使える型」を効率よく使いこなしているだけです。
その「型」を図解60Pにまとめた入門マニュアルを、完全無料でプレゼントしています。

登録10秒／合わなければ解除3秒 ／ 詳細はこちら

Linux無料マニュアル（図解60P） 名前とメールで30秒登録
宮崎 智広

この記事を書いた人

宮崎 智広（みやざき ともひろ）

株式会社イーネットマーキュリー代表。現役のLinuxサーバー管理者として20年以上の実務経験を持ち、これまでに累計3,100名以上のエンジニアを指導してきたLinux教育のプロフェッショナル。「現場で本当に使える技術」を体系的に伝えることをモットーに、実践型のLinuxセミナーの開催や無料マニュアルの配布を通じてLinux人材の育成に取り組んでいる。

趣味は、キャンプにカメラ、トラウト釣り。好きな食べ物は、ラーメンにお酒。休肝日が作れない、酒量を減らせないのが悩み。最近、ドラマ「フライトエンジェル」を観て涙腺が崩壊しました。