Get-HelpPreview
将生成的外部帮助显示为 Get-Help 输出。
语法
Default （默认值）
Get-HelpPreview
-Path <String[]>
[-ConvertNotesToList]
[-ConvertDoubleDashLists]
[<CommonParameters>]
说明
Get-HelpPreview cmdlet 将生成的外部帮助显示为 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中每个对象的 Name 属性。
参数
-ConvertDoubleDashLists
指示此 cmdlet 将双连字符列表项目符号转换为单连字符项目符号。 Windows PowerShell 文档中常见的双连字符列表。 Markdown 接受列表的单连字符。
参数属性
| 类型: | SwitchParameter |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值（按属性名称）: | False |
| 来自剩余参数的值: | False |
-ConvertNotesToList
指示此 cmdlet 将 NOTES 部分中的多个段落项的格式设置为单列表项。 此输出遵循 TechNet 格式设置。
参数属性
| 类型: | SwitchParameter |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值（按属性名称）: | False |
| 来自剩余参数的值: | False |
-Path
指定 MAML 外部帮助文件的路径数组。
参数属性
| 类型: | String[] |
| 默认值: | None |
| 支持通配符: | True |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | True |
| 来自管道的值: | True |
| 来自管道的值（按属性名称）: | False |
| 来自剩余参数的值: | False |
CommonParameters
此 cmdlet 支持通用参数：-Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction 和 -WarningVariable。 有关详细信息，请参阅 about_CommonParameters。
输入
String
可以通过管道将路径数组传递给此 cmdlet。
输出
Help Object
此 cmdlet 返回与 相同的 Get-Help 对象。
