PowerShellのコメントアウト:1行・複数行の止め方と引用符の注意点

PowerShellのコメントを、1行、複数行、引用符内の文字の3つに分けた独自図解

コメントアウトしたはずの行が動くときは、記号と引用符の位置を確認します。文字列の外で、1行なら半角の#、複数行なら半角の<#と#>を使います。この記事では、止まる範囲を小さな例で確認できます。

コメントは、コードに残す説明です。コードをコメントとして扱わせ、実行対象から外す操作をコメントアウトと呼びます。Windows PowerShellを通常権限で開けば、掲載例を試せます。

実行記録の環境はWindows PowerShell 5.1.26100.9818です。PowerShell 7.5の公式資料も根拠にしていますが、7系での実行結果はありません。

先に結論

  • 文字列の外の#は、その位置から改行までをコメントにします。次の行は実行されます。
  • 複数行は半角の<#と#>で囲みます。既存のブロックをさらに囲む方法は避けます。
  • 引用符の中の記号は文字として扱われます。関数のヘルプには専用のキーワードと配置が必要です。

通常権限のWindows PowerShellで準備する

練習用に新しい画面を開き、コードと出力を区別して試します。

掲載例は文字の表示とヘルプの確認を行うものです。管理者起動や実行ポリシーの変更は必要ありません。WindowsのスタートメニューでWindows PowerShellを検索し、通常権限で開いてください。

コード欄が入力する内容、出力欄が実行後に表示される結果です。コード欄だけを上から順にまとめて貼り付けます。出力欄や、PSなどの入力待ち表示は貼り付けません。

  1. 新しく開いた画面が、コマンドプロンプトではなくWindows PowerShellであることを確認します。
  2. 各例のコード欄を貼り付け、最後にEnterを押して実行します。
  3. 表示された結果を出力欄と比べ、練習が終わったら画面を閉じます。

掲載例はファイルやシステム設定を変更しません。最後の例で定義する練習用の関数も、この画面を閉じると残りません。

1行を止めるなら行頭に#を付ける

#から改行までがコメントになり、次の行は通常どおり実行されます。

#は半角のシャープです。文字列の外で行頭に置くと、その行をコメントにできます。コードの後ろへ置いた場合は、その位置から改行までがコメントになります。

次の例では、単一引用符で囲んだ文字を単独で書き、画面に表示します。「非表示」の行は行頭の#で止め、「開始」と「終了」の2行だけを表示する例です。

行末から改行までをコメントにする

# この行は実行しません
'開始' # ここから説明です
# '非表示'
'終了'

実行結果

開始
終了

「開始」「終了」の順に2行出れば、記録と同じ結果です。「開始」の後ろにある#は、それより前の処理を止めません。コメントアウトを解除するときは、行頭へ追加した#だけを外します。

複数行を止めるなら開始と終了の記号で囲む

ブロックコメントは、開始記号から終了記号までをまとめてコメントにします。

複数行を囲むコメントをブロックコメントと呼びます。開始は<#、終了は#>です。本文では見分けやすいよう山括弧を全角で示していますが、入力するときはコード欄の半角記号を使います。

次の例では、囲んだ中の2行を実行せず、「前」と「後」だけを表示します。まずこの短い例で範囲を確認してください。実際のファイルを編集するときは、元のファイルを別に保管してから変更します。

複数行を一時的に止める

'前'
<#
'一時停止する処理'
'もう一つの処理'
#>
'後'

実行結果

前
後

「前」「後」だけが出れば、記録と同じ結果です。入力待ちが続く場合は終了記号を確認します。未完了の入力はCtrl+Cで中断できますが、既に実行した操作は取り消せません。解除するときは追加した開始・終了記号を外します。

引用符の中の#は文字として残る

コメントの記号でも、文字列の内側では表示する文字として扱われます。

文字列は、文章などを一つの値として扱うものです。次の例では単一引用符で囲んでいます。その内側の#やブロックコメント用の記号は、コメントの開始になりません。

そのため、表示されたメッセージに記号が残っても異常ではありません。コードの実行を止めたい場合は、引用符で囲んだ部分の外側にコメントの開始記号を置きます。

文字列の記号を区別する

'# は文字です'
'<# これも文字です #>'

実行結果

# は文字です
<# これも文字です #>

2行とも記号を含めて表示されれば、記録と同じ結果です。記号を文章として表示したいなら引用符の内側、コードを止めたいなら外側、と目的を分けて位置を確認します。

行の途中の短い説明にはブロックを使う

ブロックコメントは、行の途中にも置けます。次の例にあるセミコロンは、同じ行に書いた処理を区切る記号です。左の文字を表示し、コメント部分を飛ばして、右の文字を表示します。

長い説明を途中へ詰めると、処理の区切りを追いにくくなります。説明が長くなる場合は処理を別々の行へ分け、その前の行に#で理由を書くと、変更する場所を見つけやすくなります。

行の途中へ説明を入れる

'左'; <# この部分は説明です #> '右'

実行結果

左
右

「左」「右」が別々の行に表示されます。例ではセミコロンが処理を区切り、ブロックが説明を囲んでいます。コメントを追加するときも、処理を区切る記号は保ちます。

既存のブロックをさらに囲まない

ブロックコメントを含む範囲には、各行へ#を付ける方法を選びます。

あるブロックコメントの中へ別のブロックを重ねることを、入れ子と呼びます。公式資料は入れ子を非対応と説明しています。既に開始・終了記号がある範囲を、同じ記号でさらに囲む方法は避けます。

既存のブロックを含む範囲を止めたい場合は、対象の各行の先頭へ#を付けます。元へ戻すときに元からあったコメントを消さないよう、追加した位置を確認してから編集してください。

この注意は公式資料に基づきます。入れ子の試作は想定した構文エラーと一致しなかったため、掲載した5例の成功結果には含めていません。本番の処理で試さず、小さな例で対象範囲と出力を確認します。

関数の説明をGet-Helpで読める形にする

コメントベースヘルプには、決まったキーワードと配置が必要です。

関数は、処理に名前を付けて呼び出せるようにしたものです。次の例ではfunctionで練習用の関数を定義し、波括弧の内側に処理を書きます。定義後に名前を指定すると、その処理が動きます。

コメントベースヘルプは、コメントに書いた説明をGet-Helpで読めるようにする仕組みです。例では関数本体の先頭にブロックコメントを置き、概要を表す.SYNOPSISの次の行へ説明を書いています。

コメントをヘルプとして読む

function Get-LessonLabel {
<#
.SYNOPSIS
練習用のラベルを返します。
#>
'練習'
}
(Get-Help Get-LessonLabel).Synopsis.Trim()
Get-LessonLabel

実行結果

練習用のラベルを返します。
練習

関数定義の後の行は、Get-Helpで説明を取得し、.Synopsisで概要を選び、Trim()で前後の余白を除きます。丸括弧は取得結果をまとめるためのものです。最後の行は関数自体を呼び出します。

説明文に続いて「練習」と出れば、記録と同じ結果です。普通の注釈がすべてヘルプになるわけではありません。名前の重複を避けるため、この例も新しく開いた練習用の画面で試してください。

止まらないときは記号の位置から確認する

引用符、改行、終了記号、既存ブロックの順に確認すると、止まる範囲を整理できます。

次の表は、Windows PowerShell 5.1.26100.9818で実行した5例の対応です。1行を止める場合、複数行を止める場合、記号を表示する場合を比べ、目的に合う書き方を選んでください。

コメントアウトしても、変更前に実行し終えた操作は取り消せません。ファイル削除などを安全にする機能とは考えず、実行前に対象の処理と止める範囲を確認します。

  1. 開始記号が引用符の外側にあるか確認します。
  2. 1行コメントなら、止めたい処理より前に#があるか確認します。
  3. 複数行なら、開始・終了記号が意図した範囲を囲んでいるか確認します。
  4. 対象に既存のブロックが含まれる場合は、各行へ#を付ける方法へ切り替えます。
場面 使う書き方 今回の出力
1行を止める 行頭に# 開始、終了だけ
複数行を止める <# と #> 前、後だけ
文字列に記号を書く 引用符の内側 記号も表示
行の途中の説明 短いブロック 左、右
関数の説明を読む .SYNOPSIS と Get-Help 説明文と練習

実行条件へ影響する#Requiresのような特別なコメントもあるため、注釈に見える行を一律に削除しないでください。掲載例の確認範囲は文字の表示とヘルプです。PC・スマートフォンの実ブラウザー表示や、サイト全体の脆弱性診断は行っていません。