Show-HelpPreview
通过 Get-Help输出时查看 MAML 文件内容。
语法
Path
Show-HelpPreview
[-Path] <string[]>
[-ConvertNotesToList]
[-ConvertDoubleDashLists]
[<CommonParameters>]
LiteralPath
Show-HelpPreview
[-LiteralPath] <string[]>
[-ConvertNotesToList]
[-ConvertDoubleDashLists]
[<CommonParameters>]
说明
Show-HelpPreview cmdlet 将生成的外部帮助显示为 Get-Help 输出。 以Microsoft帮助标记语言（MAML）格式指定一个或多个文件。
示例
示例 1 - 显示 MAML 文件的内容
本示例显示 PlatyPS MAML 文件的内容，如 Get-Help输出时所示。
Show-HelpPreview -Path .\Microsoft.PowerShell.PlatyPS\Microsoft.PowerShell.PlatyPS-Help.xml
参数
-ConvertDoubleDashLists
指示此 cmdlet 将双连字符列表项目符号转换为单连字符项目符号。 Windows PowerShell 文档中常见的双连字符列表。 Markdown 接受列表的单连字符。
参数属性
| 类型: | SwitchParameter |
| 默认值: | False |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值（按属性名称）: | False |
| 来自剩余参数的值: | False |
-ConvertNotesToList
指示此 cmdlet 将 NOTES 部分中的多个段落项的格式设置为单列表项。
参数属性
| 类型: | SwitchParameter |
| 默认值: | False |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值（按属性名称）: | False |
| 来自剩余参数的值: | False |
-LiteralPath
指定 MAML 帮助文件的一个或多个路径。 不支持通配符。
参数属性
| 类型: | String[] |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
| 别名: | PSPath, LP |
参数集
LiteralPath
| Position: | 1 |
| 必需: | True |
| 来自管道的值: | True |
| 来自管道的值（按属性名称）: | False |
| 来自剩余参数的值: | False |
-Path
指定 MAML 帮助文件的一个或多个路径。 支持通配符。
参数属性
| 类型: | String[] |
| 默认值: | None |
| 支持通配符: | True |
| 不显示: | False |
参数集
Path
| Position: | 1 |
| 必需: | True |
| 来自管道的值: | True |
| 来自管道的值（按属性名称）: | False |
| 来自剩余参数的值: | False |
CommonParameters
此 cmdlet 支持通用参数：-Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction 和 -WarningVariable。 有关详细信息，请参阅 about_CommonParameters。
输入
String
输出
MamlCommandHelpInfo
此 cmdlet 返回 MamlCommandHelpInfo 对象。 这是 Get-Help返回的同一对象。