PowerShellのコメントについて

コンピュータ
PowerShellのあれこれ
スポンサーリンク

書式

単行

# ここがコメント

#以降がコメントとなる
bashの単行コメント同じ

複数行

<#
ここから

コメント

ここまで
#>

コードのコメントアウトにも使えるが、本来のコメントがある場合バグになりやすいので節度を持って使うこと。

コメントアウトの代替案

if ($False)
{
    echo "コメントアウト"
}

条件が成立しないifのコードブロックで囲む。

スクリプトのヘルプ

スクリプトの先頭に以下書式でコメントを書くとヘルプとして取り扱われる。

書式

<#
.SYNOPSIS
概要

.DESCRIPTION
説明

.EXAMPLE
実行例

.PARAMETER 引数名

.LINK
関連URL

#>

ヘルプの表示

Get-Help <スクリプトファイル名>

コメント