스크립트에 주석 기반 도움말 배치

이 항목에서는 Get-Help cmdlet이 스크립트에 있을 수 있는 함수가 아닌 스크립트와 주석 기반 도움말 항목을 연결하도록 스크립트에 대한 주석 기반 도움말을 배치하는 위치를 설명합니다.

스크립트에 대한 Comment-Based 도움말을 배치할 위치

• 스크립트 파일의 시작 부분에 있습니다.

  스크립트 도움말은 주석과 빈 줄로만 스크립트에 선행될 수 있습니다.

• 스크립트 파일의 끝에 있습니다.

  도움말 이후의 스크립트 본문에 있는 첫 번째 항목이 함수 선언인 경우 스크립트 도움말의 끝과 함수 선언 사이에 두 개 이상의 빈 줄이 있어야 합니다. 그렇지 않으면 도움말이 스크립트에 대한 도움말이 아니라 함수에 대한 도움말로 해석됩니다.

스크립트의 도움말 배치 예제

다음 예제에서는 스크립트에 대한 주석 기반 도움말에 대한 각 배치 옵션을 보여 줍니다.

스크립트의 시작 부분에 대한 도움말

다음 예제에서는 스크립트의 시작 부분에 주석 기반입니다.

<#
.DESCRIPTION
This script performs a series of network connection tests.
#>

param [string]$ComputerName
...

스크립트 끝의 도움말

다음 예제에서는 스크립트의 끝에 주석 기반이 표시됩니다.

...
function Ping { Test-Connection -ComputerName $ComputerName }

<#
.DESCRIPTION
This script performs a series of network connection tests.
#>