通过

Import-YamlCommandHelp

模块:
Microsoft.PowerShell.PlatyPS Module

将 Yaml 帮助内容导入 CommandHelp 对象。

语法

Path （默认值） 

Import-YamlCommandHelp
    [-Path] <string[]>
    [-AsDictionary]
    [<CommonParameters>]

LiteralPath 

Import-YamlCommandHelp
    -LiteralPath <string[]>
    [-AsDictionary]
    [<CommonParameters>]

说明

该命令导入包含命令帮助的 Yaml 文件，并创建 CommandHelp 对象。 CommandHelp 对象是可用于导出到不同格式的帮助内容的结构化表示形式。

示例

示例 1 - 导入文件夹中的所有 cmdlet Yaml 文件

以下示例导入文件夹中的 cmdlet Markdown 文件，并将其转换为 CommandHelp 对象。 这些对象可用于导出到不同的格式。

Import-YamlCommandHelp -Path .\v2\yaml\*-*.yml | Select-Object Title

Title
-----
Compare-CommandHelp
Export-MamlCommandHelp
Export-MarkdownCommandHelp
Export-MarkdownModuleFile
Export-YamlCommandHelp
Export-YamlModuleFile
Import-MamlHelp
Import-MarkdownCommandHelp
Import-MarkdownModuleFile
Import-YamlCommandHelp
Import-YamlModuleFile
Measure-PlatyPSMarkdown
New-CommandHelp
New-MarkdownCommandHelp
New-MarkdownModuleFile
Test-MarkdownCommandHelp
Update-CommandHelp
Update-MarkdownCommandHelp
Update-MarkdownModuleFile

参数

-AsDictionary

默认情况下，此 cmdlet 返回 CommandHelp 对象。 使用此参数时。 该 cmdlet 返回与 OrderedDictionary 对象相同的信息。

参数属性

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

参数集

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

-LiteralPath

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

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

参数属性

类型:

String[]

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

参数集

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

-Path

Yaml 命令文件的路径。 指定通向一个或多个位置的路径。

参数属性

类型:

String[]

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

参数集

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

CommonParameters

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

输入

String

输出

OrderedDictionary

使用 AsDictionary 参数时，此 cmdlet 返回 OrderedDictionary 对象。

Microsoft.PowerShell.PlatyPS.Model.CommandHelp

默认情况下，此 cmdlet 返回 CommandHelp 对象。