주석 기반 도움말 구문

이 섹션에서는 주석 기반 도움말의 구문을 설명합니다.

구문 다이어그램

주석 기반 도움말의 구문은 다음과 같습니다.

# .< help keyword>
# <help content>

또는

<#
.< help keyword>
< help content>
#>

구문 설명

주석 기반 도움말은 일련의 주석으로 작성됩니다. 주석의 각 줄 앞에 주석 기호(#)를 입력하거나 <# 및 #> 기호를 사용하여 주석 블록을 만들 수 있습니다. 주석 블록 내의 모든 줄은 주석으로 해석됩니다.

주석 기반 도움말의 각 섹션은 키워드에 의해 정의되며 각 키워드 앞에 점(.)이 있습니다. 키워드는 순서에 따라 표시할 수 있습니다. 키워드 이름은 대/소문자를 구분하지 않습니다.

주석 블록에는 하나 이상의 도움말 키워드가 포함되어야 합니다. .EXAMPLE같은 일부 키워드는 동일한 주석 블록에 여러 번 나타날 수 있습니다. 각 키워드에 대한 도움말 콘텐츠는 키워드 뒤의 줄에서 시작되며 여러 줄에 걸쳐 있습니다.

주석 기반 도움말 항목의 모든 줄은 연속되어야 합니다. 메모 기반 도움말 항목이 도움말 항목의 일부가 아닌 주석을 따르는 경우 마지막 비 도움말 메모 줄과 메모 기반 도움말의 시작 사이에 빈 줄이 하나 이상 있어야 합니다.

예를 들어 다음 주석 기반 도움말 항목에는 함수 또는 스크립트에 대한 설명인 .DESCRIPTION 키워드와 해당 값이 포함됩니다.

<#
    .DESCRIPTION
    The Get-Function function displays the name and syntax of all functions in the session.
#>