本日のお題は「コメントアウト」です。
コメントアウトとはプログラム言語の中で「コードとしては実行されないけれど、意図や補足を伝えるための書き込み」を行うための機能です。
一生懸命考えて完璧に作成したプログラムでも、保守性が無ければ日常的に行われているアップデートについていくのが難しくなっていきます。
もし個人で利用するプログラムであっても、ここの処理は何をしているのかな?というものが一目で理解できた方が断然修正の速度も上がります。ましてやチームで利用していれば、他のメンバーが保守をする時にも役に立ちます。
それでは早速コメントアウトの紹介です
# コメントをここに書く
これは1行のみのコメントを書くときに使います。
ちなみに、「# 」よりも前にコードが書かれていてもコメントアウトできます。
#(例)
$num = 10 # $numの初期値
############ これもコメントアウト
# これ以降にプログラムを書いても実行されないよ $num += 1
$num # 出力結果:10
そして慣れてくると数十行にもなる一連のプログラムを書くことが出てきます。
そんな時に使用するのが「<#」「#>」この文字です
<# ここに書かれている文字は
何行書いてもコメントアウトされるよ
1行でコメントできないような処理の内容や
装飾して大きな項目の1つであることを強調するのも◎ #>
<# このようにすれば1行にもなる #>
<#
====================
これもコメントアウトされるよ
====================
#>
コメントアウトを上手に活用してキレイで保守性の高いプログラムを作りましょう!
コメント