Get-HelpPreview
將產生的外部說明顯示為 Get-Help 輸出。
Syntax
Get-HelpPreview
-Path <String[]>
[-ConvertNotesToList]
[-ConvertDoubleDashLists]
[<CommonParameters>] Description
Cmdlet 會將 Get-HelpPreview 產生的外部說明顯示為 Get-Help 輸出。
以 Microsoft 協助標記語言 (MAML) 格式指定一或多個檔案。
範例
範例 1：預覽 PlatyPS 說明
PS C:\> $Help = Get-HelpPreview -Path ".\out\platyPS\en-US\PlatyPS-help.xml"
PS C:\> $Help.Name
Get-HelpPreview
Get-MarkdownMetadata
New-ExternalHelp
New-ExternalHelpCab
New-MarkdownHelp
Update-MarkdownHelp
Update-MarkdownHelpModule
Update-MarkdownHelpSchema第一個命令會為指定的 MAML 檔案建立 Help 物件。 命令會將它儲存在 $Help 變數中。
第二個命令會顯示 $Help 中每個物件的 Name 屬性。
參數
-ConvertDoubleDashLists
表示這個 Cmdlet 會將雙連字號清單專案符號轉換成單一連字號專案符號。 Windows PowerShell檔中常見的雙連字號清單。 Markdown 接受清單的單一連字號。
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ConvertNotesToList
表示此 Cmdlet 會將 NOTES 區段中的多個段落專案格式化為單一清單專案。 此輸出遵循 TechNet 格式設定。
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Path
指定 MAML 外部說明檔的路徑陣列。
| Type: | String[] |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | True |
輸入
String[]
您可以使用管線將路徑陣列傳送至此 Cmdlet。
輸出
Help Object
此 Cmdlet 會傳回 Help 物件，其輸出與 Get-Help 相同。
