可更新的說明概觀

本檔提供PowerShell可更新說明功能設計和作業的基本簡介。 它專為將 Windows PowerShell 幫助主題提供給使用者的模組作者和其他人所設計。

簡介

PowerShell 說明主題是 PowerShell 體驗不可或缺的一部分。 如同 PowerShell 模組，作者和 PowerShell 使用者社群的貢獻都會持續更新和改進說明主題。

Windows PowerShell 3.0 中引進的 可更新說明 功能可確保使用者在命令提示字元中擁有最新版本的說明主題，即使是內建 PowerShell 命令，也不需要下載新的模組或執行 Windows Update。 可更新的說明提供 Cmdlet，從因特網下載最新版的說明主題，並將其安裝在使用者本機電腦上的正確子目錄中，讓更新變得簡單。 即使是身在防火牆後方的使用者也可以使用新的 Cmdlet，從內部檔案共用取得更新的說明。

Windows 8 和 Windows Server 2012 中的所有 Windows PowerShell 模組都完全支援可更新的說明，其功能可供所有 Windows PowerShell 模組作者使用。 可更新的說明僅支援以 XML 為基礎的說明檔。 它不支援以批注為基礎的說明。

可更新的說明包含下列功能。

• Update-Help Cmdlet，它會決定使用者是否有模組的最新說明檔，如果不是，則會從因特網下載最新的說明檔、將它們解壓縮，並將其安裝在用戶電腦上的正確模組子目錄中。 使用者可以使用 Get-Help Cmdlet，立即檢視新安裝的幫助主題。 他們不需要重新啟動PowerShell。

• Save-Help Cmdlet，它會從因特網下載最新的說明檔，並將其儲存在文件系統目錄中。 使用者可以使用 Update-Help Cmdlet 從檔案系統目錄取得說明檔，並在使用者的計算機上將檔案解壓縮並安裝到模組子目錄中。 Save-Help Cmdlet 是針對具有有限或沒有因特網存取的使用者，以及偏好限制因特網存取的企業所設計。

• 模組的說明。 模組的說明檔會以單位的形式進行管理和傳遞，讓使用者可以取得其使用之模組的所有說明檔。 只有模組才支援可更新的說明，不適用於 Windows PowerShell 嵌入式管理單元。

• 版本支援。 可更新的說明使用標準四個位置 （N1。N2.N3.N4） 版本號碼。 可更新的說明會在用戶電腦上的說明檔版本號碼（或位於 Save-Help 目錄中）低於因特網位置的說明檔版本號碼時，下載說明檔。

• 多語言支援。 可更新的說明支援多個UI文化特性中的模組說明檔。 可更新的說明檔名包括標準語言代碼，例如“en-US” 和 “ja-JP”，而 Update-Help 和 Save-Help Cmdlet 會將說明檔放入模組目錄的語言特定子目錄中。

• 自動產生的說明。 Get-Help Cmdlet 會顯示沒有說明檔案之命令的基本說明。 自動產生的說明包含命令語法和別名，以及使用在線說明和可更新說明的指示。

• 增強的線上協助。 輕鬆存取在線說明不再需要說明檔。 Get-Help Cmdlet 的 Online 參數現在會從任何命令的 HelpUri 屬性值取得在線說明主題的 URL，如果找不到說明檔中的在線說明 URL，則為 。 您可以將 HelpUri 屬性新增至 Cmdlet、函式和 CIM 命令的程式碼，或使用工作流程和腳本中的 .LINK 批注型說明關鍵詞，以填入 helpUri 屬性。

  為了讓我們的說明檔可更新，Windows 中的 Windows PowerShell 模組不會隨附說明檔。 使用者可以使用可更新的說明來安裝說明檔並加以更新。 其他模組的作者可以在模組中包含說明檔案，或省略它們。 支援可更新的說明是選擇性的，但建議使用。