Windowsのbat(バッチファイル)にメモ用のコメントを記述するREMコマンド

プログラミングを行う場合、他の人がコードを読んだときに処理をスムーズに理解できるようにコメントを書くことがあると思います。

例えばC言語であれば「//」の後に文章を書くと、この文章はプログラムの処理から除外されるため、自由にプログラムの説明を書くことができます。

Windowsのバッチファイルでも、プログラミング言語等と同様に、処理に影響を与えない形でコメントを付けられるコマンドが存在していますので、今回はそちらを紹介したいと思います。

REMコマンドを用いたコメントの付与

バッチファイルでは、REMコマンドを使うことで、その行以降の記述をコメントとして扱うことができます。コメント部分は実行されないので、処理内容の説明やメモなどを自由に記述できます。

複数行のコメントアウトはできません。1行ずつREMを付ける必要があります。

例えば、以下の例では3行目に「rem For文を実行する」と記述がありますが、これは自分用のメモであり、この行は処理に影響を与えません。

@echo off

rem For文を実行する  <- これはコメント
for /l %%i in (0,1,10) do (
	echo %%i
)

pause

コロン(:)を使ったコメントの付与

Windowsのバッチファイルではコロン1個「:」やコロン2個「::」を用いてコメントを付与することもできます。

@echo off

: For文を実行する <- これはコメント
for /l %%i in (0,1,10) do (
	echo %%i
)

pause

コロン使用時の注意点:gotoコマンドとの競合

コロン1個でコメントを追加する場合、goto コマンドのラベルと区別がつかなくなる可能性があります。goto コマンドは、指定したラベルの位置に処理をジャンプさせるコマンドで、ラベルもコロンで定義します。

@echo off

:myLabel   <- これはラベル
echo 処理A

goto myLabel 

: ここはコメント?ラベル?  <- 紛らわしい!
echo 処理B 

ただし、上記の例では、「: ここはコメント?ラベル?」の部分がコメントなのか、goto のジャンプ先なのか曖昧になってしまいます。gotoコマンドの行先のラベルの名前と、「:」で書かれるコメントの名前が重複していなければ問題はありませんが、基本的にはremを使う方が事故が少なく安全であると思います。

まとめ

  • バッチファイルでは、REM コマンド、コロン1個、コロン2個のいずれかでコメントを追加できます。
  • REM コマンドは、可読性を高めるための説明やメモなどを記述するのに便利です。
  • コロン1個でのコメントは、goto コマンドのラベルと競合する可能性があるため注意が必要です。
  • コメントを効果的に活用することで、自分自身や他の開発者にとって理解しやすいバッチファイルを作成しましょう。
スポンサーリンク

シェアする

フォローする