2010年12月9日木曜日

◆コメントベースのヘルプを記述する

以前PowerShell: ◆スクリプトファイルを作るで独自のコメントを使ったヘルプを記述したが、Ver2になってPowershellの機能としてコメントベースのヘルプがサポートされた。(about_Comment_Based_Help)
VisualStudioで言うところのコードコメントと同じイメージかな。
以下のようにスクリプトや関数の先頭にコメントを書いておく。
<#
.SYNOPSIS
    概要のテスト
.DESCRIPTION
    説明のテスト
.LINK
    http://mtgpowershell.blogspot.com/
.NOTES
    メモのテスト
.EXAMPLE
    Write-Comment ”コメント"
#>
Get-Help W:\Write-Comment.ps1 –full
っとやると以下のように通常のコマンドレットと同じ書式でヘルプが表示される。
20101209115524

0 件のコメント:

コメントを投稿