Writing Comment-Based Help Topics
You can write comment-based Help topics for functions and scripts using special Help comment keywords.
The Get-Help
cmdlet displays comment-based Help in the same format in which it displays the cmdlet
Help topics that are generated from XML files. Users can use all of the parameters of Get-Help
,
such as Detailed, Full, Example, and Online, to display function and script Help.
You can also write XML-based Help topics for scripts and functions and use the Help comment keywords to redirect users to the XML-based topics or other topics.
In This Section
- Syntax of Comment-Based Help - Describes the syntax of comment-based help.
- Comment-Based Help Keywords - Lists the keywords in comment-based help.
- Placing Comment-Based Help in Functions - Shows where to place comment-based help for a function.
- Placing Comment-Based Help in Scripts - Shows where to place comment-based help for a script.
GitHub에서 Microsoft와 공동 작업
이 콘텐츠의 원본은 GitHub에서 찾을 수 있으며, 여기서 문제와 끌어오기 요청을 만들고 검토할 수도 있습니다. 자세한 내용은 참여자 가이드를 참조하세요.
PowerShell
피드백
https://aka.ms/ContentUserFeedback
출시 예정: 2024년 내내 콘텐츠에 대한 피드백 메커니즘으로 GitHub 문제를 단계적으로 폐지하고 이를 새로운 피드백 시스템으로 바꿀 예정입니다. 자세한 내용은 다음을 참조하세요.다음에 대한 사용자 의견 제출 및 보기