通过

Import-MamlHelp

模块:
Microsoft.PowerShell.PlatyPS Module

从文件中导入 MAML 帮助，并为该文件中的每个命令创建 CommandHelp 对象。

语法

Path （默认值） 

Import-MamlHelp
    [-Path] <string[]>
    [<CommonParameters>]

LiteralPath 

Import-MamlHelp
    -LiteralPath <string[]>
    [<CommonParameters>]

说明

此命令可用于从 MAML 帮助文件创建 CommandHelp 对象。 这些对象可用于生成 Markdown 帮助文件。 还可以使用此命令测试 MAML 帮助文件的有效性。

示例

示例 1

Import-MamlHelp -Path .\maml\Microsoft.PowerShell.PlatyPS.dll-Help.xml

参数

-LiteralPath

MAML 帮助文件的路径。 指定通向一个或多个位置的路径。 LiteralPath 的值与键入的完全一样使用。 不会将任何字符解释为通配符。 如果路径包含转义字符，请将它括在单引号中。 单引号告知 PowerShell 不要将任何字符解释为转义序列。

有关详细信息，请参阅 about_Quoting_Rules。

参数属性

类型:

String[]

默认值:None
支持通配符:False
不显示:False
别名:PSPath, LP

参数集

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

-Path

MAML 帮助文件的路径。 指定通向一个或多个位置的路径。

参数属性

类型:

String[]

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

参数集

Path
Position:0
必需:True
来自管道的值:True
来自管道的值（按属性名称）:False
来自剩余参数的值:False

CommonParameters

此 cmdlet 支持通用参数：-Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction 和 -WarningVariable。 有关详细信息，请参阅 about_CommonParameters。

输入

String

输出

Microsoft.PowerShell.PlatyPS.Model.CommandHelp

备注

MAML 文件格式不支持存储在 CommandHelp 对象中的所有信息。 如果将导入的信息转换为 markdown 格式，生成的 markdown 文件不是原始命令的完整表示形式。