通过

Get-HelpPreview

模块:
platyPS Module

Displays your generated external help as Get-Help output.

语法

Default （默认值） 

Get-HelpPreview
    -Path <String[]>
    [-ConvertNotesToList]
    [-ConvertDoubleDashLists]
    [<CommonParameters>]

说明

The Get-HelpPreview cmdlet displays your generated external help as Get-Help output. Specify one or more files in Microsoft Assistance Markup Language (MAML) format.

示例

Example 1: Preview the PlatyPS help

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

The first command creates a Help object for the the specified MAML file. The command stores it in the $Help variable.

The second command displays the Name property for each of the objects in $Help.

参数

-ConvertDoubleDashLists

Indicates that this cmdlet converts double-hyphen list bullets into single-hyphen bullets. Double-hyphen lists are common in Windows PowerShell documentation. Markdown accepts single-hyphens for lists.

参数属性

类型:SwitchParameter
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值（按属性名称）:False
来自剩余参数的值:False

-ConvertNotesToList

Indicates that this cmdlet formats multiple paragraph items in the NOTES section as single list items. This output follows TechNet formatting.

参数属性

类型:SwitchParameter
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值（按属性名称）:False
来自剩余参数的值:False

-Path

Specifies an array of paths of MAML external help files.

参数属性

类型:

String[]

默认值:None
支持通配符:True
不显示:False

参数集

(All)
Position:Named
必需:True
来自管道的值:True
来自管道的值（按属性名称）:False
来自剩余参数的值:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

输入

String

You can pipe an array of paths to this cmdlet.

输出

Help Object

This cmdlet returns a Help object, which is the same output as Get-Help.