バッチファイルやPowerShellスクリプトでコメントを記述する方法

WindowsでバッチファイルやPowerShellスクリプトを作成する際、コメントを記述（コメントアウトする）したいときがあります。

コメントと記述する理由としては、バッチファイルやPowerShellスクリプトの作成日や作成者を明記したり、実行するコマンドがどのような処理を行っているか説明したり、一部の処理をデバッグ目的で無効化したいときに記述することが多いです。

そこでここでは、バッチファイルやPowerShellスクリプトのそれぞれで、コメントを記述（コメントアウト）する方法を解説します。

バッチファイルの場合

バッチファイル内で単一行のコメントを記述するときは、REMコマンドを使った方法やコロンを2つ記述する方法があります。

REM これはコメント行です。

:: これはコメント行です。;

コロンを2つ記述してコメントを記述するときは、予期せぬ動作を避けるためにコメントの末尾に「;（セミコロン）」を付けるとよいようです。

バッチファイル内で複数行のコメントを記述するときは、1行ずつREMや::を記述するのが一般的ですが、意外と知られていませんが、以下のように記述することで、複数行のコメントを記述することができます。

REM/||(
REMコマンドでは
複数行をコメントアウト
することができます。
)

PowerShellスクリプト内で単一行のコメントを記述するときは「#」を使って、以下のように記述します。

# これはコメント行です。

コマンドの後にコメントを付けることもできます。

Get-Childitem # コメントです。

PowerShellスクリプト内で複数行のコメントを記述するときは、コメントの開始部分に「<#」を記述して、コメントの終了部分に「#>」を記述します。

<#
これはコメント行です。
これはコメント行です。
これはコメント行です。
これはコメント行です。
#>

コメントを適切に記述しておけば、バッチファイルやPowerShellスクリプトを作成者以外の人が編集するときにも、どのような処理が行われているかを理解しやすくなるメリットもあります。ご活用あれ。