Comment-Based 도움말 키워드

이 항목에서는 주석 기반 도움말의 키워드를 나열하고 설명합니다.

Comment-Based 도움말의 키워드

다음은 유효한 주석 기반 도움말 키워드입니다. 일반적으로 도움말 항목에 의도한 용도와 함께 표시되는 순서대로 나열됩니다. 이러한 키워드는 주석 기반 도움말에서 순서대로 표시할 수 있으며 대/소문자를 구분하지 않습니다.

.EXTERNALHELP 키워드는 다른 모든 주석 기반 도움말 키워드보다 우선합니다. .EXTERNALHELP 있는 경우 키워드 값과 일치하는 도움말 파일을 찾을 수 없는 경우에도 Get-Help cmdlet은 주석 기반 도움말을 표시하지 않습니다.

.SYNOPSIS

함수 또는 스크립트에 대한 간략한 설명입니다. 이 키워드는 각 항목에서 한 번만 사용할 수 있습니다.

.DESCRIPTION

함수 또는 스크립트에 대한 자세한 설명입니다. 이 키워드는 각 항목에서 한 번만 사용할 수 있습니다.

.PARAMETER <Parameter-Name>

매개 변수에 대한 설명입니다. 함수 또는 스크립트에서 각 매개 변수에 대한 .PARAMETER 키워드를 포함할 수 있습니다.

.PARAMETER 키워드는 주석 블록에서 임의의 순서로 나타날 수 있지만 매개 변수가 param 문 또는 함수 선언에 나타나는 순서에 따라 매개 변수가 도움말 항목에 표시되는 순서가 결정됩니다. 도움말 항목의 매개 변수 순서를 변경하려면 param 문 또는 함수 선언에서 매개 변수의 순서를 변경합니다.

매개 변수 변수 이름 바로 앞에 param 문에 주석을 배치하여 매개 변수 설명을 지정할 수도 있습니다. param 문 주석과 .PARAMETER 키워드를 모두 사용하는 경우 .PARAMETER 키워드와 관련된 설명이 사용되고 param 문 주석은 무시됩니다.

.EXAMPLE

함수 또는 스크립트를 사용하는 샘플 명령이며, 필요에 따라 샘플 출력 및 설명이 뒤따릅니다. 각 예제에 대해 이 키워드를 반복합니다.

.INPUTS

함수 또는 스크립트에 파이프할 수 있는 개체의 .NET 형식입니다. 입력 개체에 대한 설명을 포함할 수도 있습니다. 각 입력 형식에 대해 이 키워드를 반복합니다.

.OUTPUTS

cmdlet이 반환하는 개체의 .NET 형식입니다. 반환된 개체에 대한 설명을 포함할 수도 있습니다. 각 출력 형식에 대해 이 키워드를 반복합니다.

.NOTES

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

.LINK

관련 항목의 이름입니다. 각 관련 항목에 대해 이 키워드를 반복합니다. 이 콘텐츠는 도움말 항목의 관련 링크 섹션에 표시됩니다.

.LINK 키워드 콘텐츠에는 동일한 도움말 항목의 온라인 버전에 대한 URI(Uniform Resource Identifier)도 포함될 수 있습니다. 매개 변수 Get-Help 을 사용할 때 온라인 버전이 열립니다. URI는 다음으로 httphttps시작해야 합니다.

.COMPONENT

함수 또는 스크립트가 사용하거나 관련된 기술 또는 기능의 이름입니다. Component Get-Help 매개 변수는 이 값을 사용하여 Get-Help반환된 검색 결과를 필터링합니다.

.ROLE

도움말 항목의 사용자 역할 이름입니다. Role Get-Help 매개 변수는 이 값을 사용하여 Get-Help반환된 검색 결과를 필터링합니다.

.FUNCTIONALITY

함수의 의도된 사용을 설명하는 키워드입니다. Functionality Get-Help 매개 변수는 이 값을 사용하여 Get-Help반환된 검색 결과를 필터링합니다.

.FORWARDHELPTARGETNAME <Command-Name>

지정된 명령에 대한 도움말 항목으로 리디렉션됩니다. 함수, 스크립트, cmdlet 또는 공급자에 대한 도움말 콘텐츠를 비롯한 모든 도움말 항목으로 사용자를 리디렉션할 수 있습니다.

# .FORWARDHELPTARGETNAME <Command-Name>

.FORWARDHELPCATEGORY

.FORWARDHELPTARGETNAME항목의 도움말 범주를 지정합니다. 유효한 값은 Alias, Cmdlet, HelpFile, Function, Provider, General, FAQ, Glossary, ScriptCommand, ExternalScript, Filter또는 All. 이름이 같은 명령이 있는 경우 충돌을 방지하려면 이 키워드를 사용합니다.

# .FORWARDHELPCATEGORY <Category>

.REMOTEHELPRUNSPACE <PSSession-variable>

도움말 항목이 포함된 세션을 지정합니다. PSSession 개체가 포함된 변수를 입력합니다. 이 키워드는 [Export-PSSession][09] cmdlet에서 내보낸 명령에 대한 도움말 콘텐츠를 찾는 데 사용됩니다.

# .REMOTEHELPRUNSPACE <PSSession-variable>

.EXTERNALHELP

스크립트 또는 함수에 대한 XML 기반 도움말 파일을 지정합니다.

# .EXTERNALHELP <XML Help File>

함수 또는 스크립트가 XML 파일에 문서화될 때는 .EXTERNALHELP 키워드가 필요합니다. 이 키워드가 없으면 Get-Help 함수 또는 스크립트에 대한 XML 기반 도움말 파일을 찾을 수 없습니다.

.EXTERNALHELP 키워드는 다른 주석 기반 도움말 키워드보다 우선합니다. .EXTERNALHELP가 존재하는 경우, Get-Help 키워드의 값과 일치하는 도움말 항목을 찾을 수 없더라도, .EXTERNALHELP은 주석 기반 도움말을 표시하지 않습니다.

모듈에서 함수를 내보내는 경우 경로가 없는 파일 이름으로 .EXTERNALHELP 키워드의 값을 설정합니다. Get-Help 는 모듈 디렉터리의 언어별 하위 디렉터리에서 지정된 파일 이름을 찾습니다. 함수에 대한 XML 기반 도움말 파일의 이름에 대한 요구 사항은 없습니다. PowerShell 5.0부터 모듈에서 내보낸 함수는 모듈에 이름이 지정된 도움말 파일에 문서화할 수 있습니다. 주석 키워드를 사용할 .EXTERNALHELP 필요가 없습니다. 예를 들어 모듈에서 Test-Function 함수를 내보낸 MyModule 경우 도움말 파일 MyModule-help.xml의 이름을 지정할 수 있습니다. cmdlet은 Get-Help 모듈 디렉터리의 파일에서 함수에 MyModule-help.xml 대한 Test-Function 도움말을 찾습니다.

함수가 모듈에 포함되지 않은 경우 XML 기반 도움말 파일의 경로를 포함합니다. 값에 경로가 포함되고 경로에 UI 문화권별 하위 디렉터리가 포함된 경우 Get-Help 모듈 디렉터리에서와 마찬가지로 Windows에 설정된 언어 대체 표준에 따라 스크립트 또는 함수의 이름을 가진 XML 파일을 재귀적으로 검색합니다.

cmdlet 도움말 XML 기반 도움말 파일 형식에 대한 자세한 내용은 Cmdlet 도움말작성하는 방법을 참조하세요.