本章節中的主題說明如何建立和填入說明資訊檔(通常稱為 "HelpInfo XML file"),以取得 PowerShell 可更新的說明功能。
HelpInfo XML 檔案總覽
HelpInfo XML 檔案是有關模組可更新說明的主要資訊來源。 它包含模組的說明檔位置、支援的 UI 文化特性,以及可更新的說明用來判斷使用者是否有最新說明檔案的版本號碼。
即使模組包含多個 UI 文化特性的多個說明檔,每個模組都只會有一個 HelpInfo XML 檔案。 模組作者會建立 HelpInfo XML 檔案,並將它放在模組資訊清單中 HelpInfoUri 索引鍵所指定的網際網路位置。 當模組說明檔案更新並上傳時,模組作者會更新 HelpInfo XML 檔案,並以新版本取代原始的 HelpInfo XML 檔案。
務必小心維護 HelpInfo XML 檔案。 如果您上傳新檔案,但忘記遞增版本號碼,可更新的說明將不會將新檔案下載至使用者的電腦。 如果您加入新 UI 文化特性的說明檔,但未更新 HelpInfo XML 檔案,或將它放在正確的位置,可更新的說明將不會下載新的檔案。
本節內容
本節包含下列主題。