PowerShell: コメントの記述方法

PowerShellコメント(注釈) を記述する場合は、 単一行コメントと複数行コメントの2種類あり、 どちらも「#」(シャープ記号)を使います。

PowerShellスクリプト内に適切なコメントを入れることで 可読性が高くなり、メンテナンスもしやすくなります。

単一行コメント

単一行のコメントは「#」(シャープ記号)です。
「#」以降がコメントと見なされ、 行頭に「#」を付けると行全体がコメントとなり、 行の途中で「#」を付けると#以降がコメントとなります。

# 行全体がコメント

Write-Host "Hello" # シャープ記号以下がコメント

複数行コメント

複数行コメントは「<#」と「#>」の間に囲まれている部分です。

<#
複数行コメント
複数行コメント
複数行コメント
#>

次のように「<#」の後や「#>」の前に改行が無くても大丈夫です。


<# 複数行コメント
複数行コメント #>

注意:入れ子にはできない

複数行のコメントの注意点として、 「<# ~ #>」の中に「<# ~ #>」を入れることはできません (入れ子は不可)。
次のコードは「コメント2」の前にある 「#>」でコメントが終了すると解釈されます。 そのため「コメント2」の部分がコメントと見なされずに エラーとなります。


<# 
コメント1
<# 複数行コメントの入れ子はできない #>
コメント2
#>
PowerShell