共用方式為

Import-YamlCommandHelp

模組:
Microsoft.PowerShell.PlatyPS Module

將 Yaml 說明內容匯入 CommandHelp 物件。

語法

Path (預設值) 

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

LiteralPath 

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

Description

此命令會匯入 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 物件。