共用方式為

Import-MamlHelp

模組:
Microsoft.PowerShell.PlatyPS Module

從檔案匯入MAML說明，併為檔案中的每個命令建立 CommandHelp 物件。

語法

Path (預設值) 

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

LiteralPath 

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

Description

此命令可用來從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 檔案不是原始命令的完整表示法。