共用方式為

Import-YamlModuleFile

模組:
Microsoft.PowerShell.PlatyPS Module

將 Yaml 模組檔案匯入 ModuleHelp 物件。

語法

Path (預設值) 

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

LiteralPath 

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

Description

命令會匯入包含模組說明的 Yaml 檔案，並建立 ModuleHelp 物件。 ModuleHelp 物件是可用來匯出成不同格式之說明內容的結構化表示法。

範例

範例 1 - 將 Yaml 模組檔案匯入 **ModuleHelp** 物件

Import-YamlModuleFile .\v2\yaml\Microsoft.PowerShell.PlatyPS.yml

Metadata      : {[document type, module], [HelpInfoUri, ], [Locale, en-US], [Module Guid,
                0bdcabef-a4b7-4a6d-bf7e-d879817ebbff]…}
Title         : Microsoft.PowerShell.PlatyPS Module
Module        : Microsoft.PowerShell.PlatyPS
ModuleGuid    : 0bdcabef-a4b7-4a6d-bf7e-d879817ebbff
Description   : This module contains cmdlets to help with the creation help content for PowerShell commands.
Locale        : en-US
CommandGroups : {Microsoft.PowerShell.PlatyPS.ModuleCommandGroup}
Diagnostics   : Microsoft.PowerShell.PlatyPS.Model.Diagnostics

參數

-AsDictionary

根據預設，命令會傳回 ModuleHelp 物件。 當您使用此參數時，命令會傳回 ModuleHelp 字典對象的數據。

參數屬性

類型: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
來自管線的值:True
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-Path

指定包含 Yaml 模組檔案之一或多個位置的路徑。

參數屬性

類型:

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.ModuleFileInfo