rem - コメント
バッチファイルを記述している際、そのコードがどういったことを行うのか、後から見返す際に分かりやすくするために、コメントを記述したいケースは多々あると思います。
または、バッチファイルを利用するのが不特定多数の人であったり、自分以外の人にも見てもらうことがある場合、そのコードの意図を説明するためにコメントを記述することもあるかと思います。
このページでは、バッチファイルでコメントを記述する方法について、基本的な使い方からオプションの設定方法まで分かり易く説明しています。
また、バッチファイルをテキストで開いた場合のみ表示するコメントと、コマンドプロンプト上で表示されるコメントの 2 種類についても解説しています。
rem コマンドの基本的な使い方
バッチファイルにコメントを記述する場合、remコマンドを使用します。
使い方は以下の通りです。
rem [コメント]
例えば、以下のようにバッチファイルを記述したとします。
@echo off
setlocal
rem 好きな果物を変数に格納
echo 好きな果物を入力してください。
set /p fruit=例:りんご
endlocal
このバッチファイルを実行すると、以下のように表示されます。
remコマンドで記述したコメントは、コマンドプロンプト上には表示されず、echoコマンドで記述した内容のみが表示されていることが分かります。
コマンドプロンプトへの表示の制御
前述したバッチファイルのサンプルコートでは、先頭に@echo offを記述しています。
これは、そのバッチファイル全体で、コマンドプロンプト上に表示される内容を制御するためのコマンドです。
このコマンドを記述することで、echoコマンドで記述した内容以外は、コマンドプロンプト上に表示されなくなります。
このコマンドを記述しなかった場合、remコマンドで記述していたとしても、コマンドプロンプト上に表示されてしまいます。
これを避ける方法として、前述した@echo offの他に、@remを記述する方法もあります。
@remは、remコマンドと同じ機能を持つコマンドですが、コマンドプロンプト上には表示されません。
例として、@echo offも@remも使用しない以下のバッチファイルを記述したとします。
setlocal
rem 好きな果物を変数に格納
echo 好きな果物を入力してください。
set /p fruit=例:りんご
endlocal
上記のバッチファイルを実行すると、コマンドプロンプト上には以下のように表示されます。
rem 好きな果物を変数に格納というコメントも、コマンドプロンプト上に表示されてしまっています。
次に、remを@remに変更したバッチファイルを用意します。
setlocal
@rem 好きな果物を変数に格納
echo 好きな果物を入力してください。
set /p fruit=例:りんご
endlocal
上記のバッチファイルを実行すると、コマンドプロンプト上には以下のように表示されます。
この場合は、remコマンドで記述したコメントは、コマンドプロンプト上に表示されていません。
このように、@echo offや@remを記述しない場合、remコマンドで記述したコメントは、コマンドプロンプト上に表示されてしまうことに注意してください。
エラーが発生する場合
remコマンドで記述したバッチファイルでエラーが発生する場合、文字コードが影響している可能性があります。
バッチファイルには日本語を記述することができますが、その際には文字コードに注意する必要があります。
一般的な文字コードであるUTF-8を利用すると、remコマンドで記述したコメントの文字化けが発生することがあります。
また、場合によってはエラーが発生することもあります。
そのため、日本語を記述する場合は、文字コードをShift-JISに設定することをおすすめします。