PowerShell
I Love PowerShell
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
っとやると以下のように通常のコマンドレットと同じ書式でヘルプが表示される。
0 件のコメント:
コメントを投稿
次の投稿
前の投稿
ホーム
登録:
コメントの投稿 (Atom)
0 件のコメント:
コメントを投稿