How to name a HelpInfo XML file
Note
Manual authoring of XML-based help is very difficult. The PlatyPS module allows you to write help in Markdown and then convert it to XML-based help. This makes it much easier to write and maintain help. PlatyPS can also create the Updateable Help packages for you. For more information, see Create XML-based help using PlatyPS.
This topic explains the required name format for the Updatable Help Information files, commonly known as HelpInfo XML files. A HelpInfo XML file must have a name with the following format.
<ModuleName>_<ModuleGUID>_HelpInfo.xml
The elements of the name are as follows.
<ModuleName>
- The value of the Name property of the ModuleInfo object that the Get-Module cmdlet returns.<ModuleGUID>
- The value of the GUID key in the module manifest.
For example, if the module name is "TestModule" and the module GUID is 9cabb9ad-f2ac-4914-a46b-bfc1bebf07f9, the name of the HelpInfo XML file for the module would be:
TestModule_9cabb9ad-f2ac-4914-a46b-bfc1bebf07f9_HelpInfo.xml
PowerShell
피드백
https://aka.ms/ContentUserFeedback
출시 예정: 2024년 내내 콘텐츠에 대한 피드백 메커니즘으로 GitHub 문제를 단계적으로 폐지하고 이를 새로운 피드백 시스템으로 바꿀 예정입니다. 자세한 내용은 다음을 참조하세요.다음에 대한 사용자 의견 제출 및 보기