함수에 주석 기반 도움말 배치

이 항목에서는 Get-Help cmdlet이 주석 기반 도움말 항목을 올바른 함수와 연결하도록 함수에 대한 주석 기반 도움말을 배치하는 위치를 설명합니다.

함수에 대한 Comment-Based 도움말을 배치할 위치

• 함수 본문의 시작 부분에 있습니다.

• 함수 본문의 끝 부분에 있습니다.

• Function 키워드 앞에 있습니다. 함수가 스크립트 또는 스크립트 모듈에 있는 경우 주석 기반 도움말의 마지막 줄과 Function 키워드 사이에 둘 이상의 빈 줄이 있을 수 없습니다. 그렇지 않으면 Get-Help 함수가 아닌 스크립트와 도움말을 연결합니다.

함수의 도움말 배치 예제

다음 예제에서는 함수에 대한 주석 기반 도움말에 대한 세 가지 배치 옵션을 각각 보여 줍니다.

함수 본문의 시작 부분에 대한 도움말

다음 예제에서는 함수 본문의 시작 부분에 주석 기반입니다.

function MyProcess
{
    <#
       .DESCRIPTION
       The MyProcess function gets the Windows PowerShell process.
    #>

    Get-Process powershell
}

함수 본문 끝에 있는 도움말

다음 예제에서는 함수 본문의 끝에 있는 주석 기반입니다.

function MyFunction
{
    Get-Process powershell

    <#
       .DESCRIPTION
       The MyProcess function gets the Windows PowerShell process.
    #>
}

함수 키워드 앞의 도움말

다음 예제에서는 함수 키워드 앞의 줄을 기준으로 주석을 기반으로 합니다.

<#
    .DESCRIPTION
    The MyProcess function gets the Windows PowerShell process.
#>
function MyFunction { Get-Process powershell}