PowerShell 모듈에 대한 도움말 작성

PowerShell 모듈에는 모듈 및 cmdlet, 공급자, 함수 및 스크립트와 같은 모듈 멤버에 대한 도움말 항목이 포함될 수 있습니다. 이 cmdlet은 Get-Help 다른 PowerShell 항목에 대한 도움말을 표시하는 것과 동일한 형식으로 모듈 도움말 항목을 표시하고 사용자는 표준 Get-Help 명령을 사용하여 도움말 항목을 가져옵니다.

이 문서에서는 모듈 도움말 항목의 형식 및 올바른 배치에 대해 설명하고 모듈 도움말 콘텐츠에 대한 지침을 제안합니다.

모듈 도움말 유형

모듈에는 다음과 같은 유형의 도움말이 포함될 수 있습니다.

XML 기반 도움말
- Cmdlet 도움말. 모듈의 cmdlet을 설명하는 도움말 항목은 명령 도움말 스키마를 사용하는 XML 파일입니다.
- 공급자 도움말. 모듈의 공급자를 설명하는 도움말 항목은 공급자 도움말 스키마를 사용하는 XML 파일입니다.
- 함수 도움말. 모듈의 함수를 설명하는 도움말 항목은 명령 도움말 스키마 또는 함수 내의 주석 기반 도움말 항목 또는 스크립트 또는 스크립트 모듈을 사용하는 XML 파일일 수 있습니다.
- 도움말을 스크립깅합니다. 모듈의 스크립트를 설명하는 도움말 항목은 스크립트 또는 스크립트 모듈의 명령 도움말 스키마 또는 주석 기반 도움말 항목을 사용하는 XML 파일일 수 있습니다.
- 폴더에는 $PSHOME\Schemas\PSMaml XML 형식을 정의하는 스키마 파일이 포함되어 있습니다.
개념("정보") 도움말 텍스트 파일

개념적("정보") 도움말 항목을 사용하여 모듈과 해당 멤버를 설명하고 멤버를 함께 사용하여 작업을 수행하는 방법을 설명할 수 있습니다. 기본적으로 PowerShell에는 이러한 개념 정보 도움말 항목 중 100개 이상이 포함됩니다. 파일 이름은 형식(예: about_<name>.help.txt.)을 about_MyModule.help.txt 사용해야 합니다.

비고

섹션 머리글은 TOPIC 파일의 첫 번째 줄에 있는 첫 번째 열에서 시작해야 합니다. 두 번째 줄의 섹션 콘텐츠는 접미사가 없는 .help.txt 파일 이름과 일치해야 합니다. 콘텐츠를 정확히 4개 공백으로 들여쓰기해야 합니다. 세 번째 줄은 비어 있어야 합니다. 구역 머리글은 SYNOPSIS 네 번째 줄의 첫 번째 열에서 시작해야 합니다. 5번째 줄의 내용을 정확히 4개 공백으로 들여쓰기해야 합니다. cmdlet이 콘텐츠를 올바르게 인식하려면 이러한 요구 사항이 필요합니다 Get-Help .
```
TOPIC
    about_<subject or module name>

SYNOPSIS
    A short, one-line description of the topic contents.
```
개념 도움말 항목을 작성하기 위한 시작점으로 다음 샘플 템플릿을 사용할 수 있습니다. 처음 두 섹션을 제외하고 개념 도움말 항목의 구조는 임의입니다. 나머지 섹션 제목은 콘텐츠에 적합한 것이 무엇이든 될 수 있습니다.
```
TOPIC
    about_<subject or module name>

SYNOPSIS
    A short, one-line description of the topic contents.

LONG DESCRIPTION

A detailed, full description of the subject or purpose of the module.

EXAMPLES

Examples of how to use the module or how the subject feature works in
practice.

TROUBLESHOOTING

Instructions for resolving common problems.

SEE ALSO

Text-only references for further reading. Hyperlinks can't work in the
PowerShell console.
```
원하는 스타일과 태그를 사용할 수 있지만 PowerShell은 일반 텍스트로 표시되며 PowerShell 콘솔에는 텍스트의 특수 렌더링이 없습니다. 다음 제안은 최상의 표시 결과와 가독성을 보장합니다.
- BOM 인코딩과 함께 UTF-8을 사용하여 특수(멀티바이트) 문자가 올바르게 표시되도록 합니다.
- 섹션 머리글에 밑줄을 표시하거나 모든 대문자를 사용하여 돋보이게 합니다. 이렇게 하면 콘텐츠를 더 쉽게 검색할 수 있습니다.
- 각 줄의 길이를 80자로 제한합니다.
- 코드 블록을 들여쓰기하고 주변 산문과 구분하는 출력 예제입니다.

모듈 도움말 배치

cmdlet은 Get-Help 모듈 디렉터리의 언어별 하위 디렉터리에서 모듈 도움말 항목 파일을 찾습니다.

예를 들어 다음 디렉터리 구조 다이어그램은 SampleModule 모듈에 대한 도움말 항목의 위치를 보여 줍니다.

<ModulePath>
    \SampleModule
        \<en-US>
            \about_SampleModule.help.txt
            \SampleModule.dll-help.xml
            \SampleNestedModule.dll-help.xml
        \<fr-FR>
            \about_SampleModule.help.txt
            \SampleModule.dll-help.xml
            \SampleNestedModule.dll-help.xml

비고

이 예제 <ModulePath> 에서 자리 표시자는 환경 변수의 경로PSModulePath(예: $HOME\Documents\Modules$PSHOME\Modules) 또는 사용자가 지정하는 사용자 지정 경로 중 하나를 나타냅니다.

모듈 도움말 가져오기

사용자가 모듈을 세션으로 가져오면 해당 모듈에 대한 도움말 항목이 모듈과 함께 세션으로 가져옵니다. 도움말 항목 파일을 모듈 매니페스트의 FileList 키 값에 나열할 수 있지만 도움말 항목은 cmdlet의 Export-ModuleMember 영향을 받지 않습니다.

모듈 도움말 항목을 다른 언어로 제공할 수 있습니다. cmdlet은 Get-Help 제어판의 국가 및 언어 옵션 항목에서 현재 사용자에 대해 지정된 언어로 모듈 도움말 항목을 자동으로 표시합니다. Windows Vista 이상 버전의 Windows에서는 Windows Get-Help 용으로 설정된 언어 대체 표준에 따라 모듈 디렉터리의 언어별 하위 디렉터리에서 도움말 항목을 검색합니다.

PowerShell 3.0부터 cmdlet 또는 함수에 대한 명령을 실행 Get-Help 하면 모듈의 자동 가져오기가 트리거됩니다. 이 cmdlet은 Get-Help 모듈에 있는 도움말 항목의 내용을 즉시 표시합니다.

모듈에 도움말 항목이 없고 사용자 컴퓨터 Get-Help 의 모듈에 있는 명령에 대한 도움말 항목이 없는 경우 자동으로 생성된 도움말이 표시됩니다. 자동 생성된 도움말에는 명령 구문, 매개 변수 및 입력 및 출력 형식이 포함되지만 설명은 포함되지 않습니다. 자동 생성된 도움말에는 사용자가 cmdlet을 사용하여 Update-Help 인터넷 또는 파일 공유에서 명령에 대한 도움말을 다운로드하도록 지시하는 텍스트가 포함됩니다. 또한 cmdlet의 Online 매개 변수를 Get-Help 사용하여 도움말 항목의 온라인 버전을 가져오는 것이 좋습니다.

Updatable 도움말 지원

PowerShell 3.0 이상 버전의 PowerShell 사용자는 인터넷 또는 로컬 파일 공유에서 모듈에 대한 업데이트된 도움말 파일을 다운로드하여 설치할 수 있습니다. 및 Update-Help cmdlet은 Save-Help 사용자로부터 관리 세부 정보를 숨깁니다. 사용자는 cmdlet을 Update-Help 실행한 다음, cmdlet을 Get-Help 사용하여 PowerShell 명령 프롬프트에서 모듈에 대한 최신 도움말 파일을 읽습니다. 사용자는 Windows 또는 PowerShell을 다시 시작할 필요가 없습니다.

방화벽 뒤에 있는 사용자와 인터넷에 액세스할 수 없는 사용자도 Updatable 도움말을 사용할 수 있습니다. 인터넷에 액세스할 수 있는 관리자는 cmdlet을 Save-Help 사용하여 최신 도움말 파일을 다운로드하여 파일 공유에 설치합니다. 그런 다음 사용자는 cmdlet의 Update-Help 매개 변수를 사용하여 파일 공유에서 최신 도움말 파일을 가져옵니다.

모듈 작성자는 모듈에 도움말 파일을 포함하고 업데이트 가능한 도움말을 사용하여 도움말 파일을 업데이트하거나 모듈에서 도움말 파일을 생략하고 업데이트 가능한 도움말을 모두 사용하여 설치 및 업데이트할 수 있습니다.

Updatable 도움말에 대한 자세한 내용은 지원 도움말참조하세요.

온라인 도움말 지원

컴퓨터에 업데이트된 도움말 파일을 설치할 수 없거나 설치할 수 없는 사용자는 종종 온라인 버전의 모듈 도움말 항목을 사용합니다. cmdlet의 Get-Help 매개 변수는 기본 인터넷 브라우저에서 사용자에 대한 cmdlet 또는 고급 함수 도움말 항목의 온라인 버전을 엽니다.

cmdlet은 Get-Help cmdlet 또는 함수의 HelpUri 속성 값을 사용하여 도움말 항목의 온라인 버전을 찾습니다.

PowerShell 3.0부터 cmdlet 클래스의 HelpUri 특성 또는 CmdletBinding 특성의 HelpUri 속성을 정의하여 사용자가 온라인 버전의 cmdlet 및 함수 도움말 항목을 찾을 수 있습니다. 특성 값은 cmdlet 또는 함수의 HelpUri 속성 값입니다.

자세한 내용은 온라인 도움말 지원을 참조하세요.

또한 참조하십시오

피드백

이 페이지가 도움이 되었나요?

Last updated on 2025-10-02