Get-Help cmdlet을 사용하여 도움말 메시지로 표시되는 함수 주석을 작성하는 방법입니다.

Get-Help <自作の関数名>

함수에서 주석 기반 도움말을 설명하는 위치는 function 바로 앞, function { 뒤 또는 function 끝 } 앞에 있습니다. 스크립트의 주석 기반 도움말을 설명하는 위치는 파일의 첫 번째 또는 마지막입니다.

Windows PowerShell ISE 사용

Windows PowerShell ISE 스니펫 기능을 활용하여 cmdlet 도움말이 있는 함수 템플릿을 삽입하는 방법입니다.

Windows PowerShell ISE에서 새 스크립트 탭의 텍스트 편집기 부분을 마우스 오른쪽 단추로 클릭하고 스니펫 시작(S)을 선택합니다.

스니펫 목록에서 Cmdlet(고급 함수) 또는 Cmdlet(고급 함수) - 마침을 선택하여 템플릿을 삽입합니다.

Cmdlet(고급 함수) - 완료

<#
.Synopsis
   短い説明
.DESCRIPTION
   詳しい説明
.EXAMPLE
   このコマンドレットの使用方法の例
.EXAMPLE
   このコマンドレットの使用方法の別の例
.INPUTS
   このコマンドレットへの入力 (存在する場合)
.OUTPUTS
   このコマンドレットからの出力 (存在する場合)
.NOTES
   全般的な注意
.COMPONENT
   このコマンドレットが属するコンポーネント
.ROLE
   このコマンドレットが属する役割
.FUNCTIONALITY
   このコマンドレットの機能
#>
function Verb-Noun
{
    [CmdletBinding(DefaultParameterSetName='Parameter Set 1', 
                  SupportsShouldProcess=$true, 
                  PositionalBinding=$false,
                  HelpUri = 'http://www.microsoft.com/',
                  ConfirmImpact='Medium')]
    [Alias()]
    [OutputType([String])]
    Param
    (
        # パラメーター 1 のヘルプの説明
        [Parameter(Mandatory=$true, 
                   ValueFromPipeline=$true,
                   ValueFromPipelineByPropertyName=$true, 
                   ValueFromRemainingArguments=$false, 
                   Position=0,
                   ParameterSetName='Parameter Set 1')]
        [ValidateNotNull()]
        [ValidateNotNullOrEmpty()]
        [ValidateCount(0,5)]
        [ValidateSet("sun", "moon", "earth")]
        [Alias("p1")] 
        $Param1,

        # パラメーター 2 のヘルプの説明
        [Parameter(ParameterSetName='Parameter Set 1')]
        [AllowNull()]
        [AllowEmptyCollection()]
        [AllowEmptyString()]
        [ValidateScript({$true})]
        [ValidateRange(0,5)]
        [int]
        $Param2,

        # パラメーター 3 のヘルプの説明
        [Parameter(ParameterSetName='Another Parameter Set')]
        [ValidatePattern("[a-z]*")]
        [ValidateLength(0,15)]
        [String]
        $Param3
    )

    Begin
    {
    }
    Process
    {
        if ($pscmdlet.ShouldProcess("Target", "Operation"))
        {
        }
    }
    End
    {
    }
}

댓글 기반 도움말 키워드

대표적인 키워드 목록입니다. ※자세한 것은 about_Comment_Based_Help 를 참조


키워드
설명


.SYNOPSIS
함수 또는 스크립트의 간략한 개요.

.DESCRIPTION
함수 또는 스크립트에 대한 자세한 설명.

.PARAMETER <파라미터명>
매개변수 설명. 이 매개변수 앞의 댓글보다 우선합니다.

.EXAMPLE
함수 또는 스크립트를 사용하는 샘플 명령. 필요에 따라, 샘플 출력과 설명을 기술합니다 (복수 가능). 예 1, 예 2, 예 3 ...

.INPUTS
파이프를 사용하여 함수나 스크립트에 전달할 수 있는 개체의 Microsoft .NET Framework 형식입니다. 입력 오브젝트에 대한 설명을 포함할 수도 있습니다.

.OUTPUTS
cmdlet에서 반환하는 개체의 .NET Framework 형식입니다. 돌려주어지는 오브젝트의 설명을 포함할 수도 있습니다.

.NOTES
함수 또는 스크립트에 대한 추가 정보.

.LINK
관련 링크 주제 (cmdlet 이름) 또는 URI.

참고 사이트

about_Comment_Based_Help

댓글 기반 도움말 만들기

고급 기능