作業内容や日付、作業した人物などをメモとして記述する場合に使用します。
後から見直した時や第三者が内容を見た時に、
状況や内容を把握しやすくするために使用されます。
※しかしたまに、コメントと実際の処理内容、設定内容が異なる場合があります。
それを見落とすとトラブルの元になりますので、
コメントのメンテナンスもしっかりやりましょう。
プログラムにしてもLinuxの設定ファイルにしても、
コメントして記述した箇所はシステム的に無視されるので
システムに影響しません。
Pythonでコメントを記述する
Pythonでコメントするには、「#」を使用します。 #以降から行末までがコメントとなり、システム的に無視されます。#以降がコメントとしてシステム的に無視されます。
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)
P.S
Pythonでコメントを記述するのもっと高い技術を身につけたいならこちら
<<関連記事>>
・Pythonを対話モードで起動する
・CentOS(Linux)にPythonをインストール(Python2/Python3)