PowerShellスクリプトのコメントの書き方（1行・複数行）

PowerShell スクリプトファイルでは、コメントを記述できます。コメントには、 1 行コメントと複数行コメントがあります。ここでは PowerShell スクリプトファイルでコメントを記述する方法について解説します。

PowerShellスクリプトでコメントを記述する

PowerShell スクリプトファイルにコメントを記述したい場合、 1 行のコメントと複数行のコメントを記述できます。コメントは処理には影響せず、コードの説明やメモとして使用されます。

1 行のコメント（行末コメント）を記述する場合は # のあとにコメントを記述します。

# コメントを記述します
Get-ChildItem c:\code  # 途中からコメントを記述できます

コメントは行の先頭に記述することも、コマンドの後ろに記述することもできます。 # のあとは行末までの部分がすべてコメントとなります。

複数行のコメント（ブロックコメント）を記述する場合は <# から #> の間にコメントを記述します。

<#
複数行にわたるコメントを
記述したい場合に
便利な方法です
#>
Get-ChildItem c:\code

複数行のコメントを記述したい場合や、一定の範囲にあるスクリプトを一時的に無効にするため、コメントとして無効化したい場合に便利です。

行の先頭にコメントを記述したあとにコマンドを続けて書きたい場合、 # を使用すると行末までがコメントとなってしまいます。そのような場合は、複数行コメントで使用する <# と #> を使って、次のように記述することができます。

<# コメントを記述 #> Get-ChildItem c:\code

ただし、一時的にコメントを追加したい場合にこのようなコメントの記述方法も行えますが、このような書き方はあまり一般的ではないため、通常はコメントとコマンドは別の行に分けて記述することをおすすめします。

ブロックコメント内には、 1 行コメントを含めることができます。例えば、 1 行コメントが含まれているコードを一時的にまとめてコメントにする場合、コメントブロック内に 1 行のコメントが入っていても問題なく使用できます。

<#
一時的にコメントにします

Get-ChildItem c:\code  # 元々記述していたコメント

#>

ただし、ブロックコメントを入れ子にすることはできません。例えば元々ブロックコメントが記述されている範囲を、まとめてブロックコメントにしようとすると、外側のブロックコメントは最初に見つかった #> で終了します。

<#
一時的にコメントにします

<#
元々複数行のコメントが
記述されていた
#>
Get-ChildItem c:\code

#>

このような場合は意図しない範囲でコメントが終了してしまうため、注意が必要です。

-- --

PowerShell スクリプトファイルでコメントを記述する方法について解説しました。

( Written by Tatsuo Ikura )

これから IT 関連の知識を学ばれる方を対象に、色々な言語でのプログラミング方法や関連する技術、開発環境構築などに関する解説サイトを運営しています。