共用方式為

Update-CommandHelp

模組:
Microsoft.PowerShell.PlatyPS Module

使用相同名稱的會話 Cmdlet 中的資訊，更新匯入 CommandHelp 物件。

語法

Path (預設值) 

Update-CommandHelp
    [-Path] <string[]>
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

LiteralPath 

Update-CommandHelp
    -LiteralPath <string[]>
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

此 Cmdlet 會從 Markdown 檔案匯入 CommandHelp 物件，並使用相同名稱之會話 Cmdlet 的資訊來更新物件。 然後可以重新導出更新的物件，以更新來源 Markdown 檔案。

範例

範例 1

$mdfiles = Measure-PlatyPSMarkdown -Path .\v1\Microsoft.PowerShell.PlatyPS\*.md
$cmdobj = $mdfiles | Where-Object Filetype -match 'CommandHelp' |
    Update-CommandHelp -Path {$_.FilePath}
$cmdobj.count

19

參數

-Confirm

在執行 Cmdlet 之前，提示您進行確認。

參數屬性

類型:SwitchParameter
預設值:False
支援萬用字元:False
不要顯示:False
別名:cf

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-LiteralPath

指定一或多個 Markdown 命令檔案的路徑。 LiteralPath 的值會被原樣使用，不做任何更改。 不會將任何字元解譯為通配符。 如果路徑包含逸出字元，請以單引弧括住它。 單引號會告知PowerShell不要將任何字元解譯為逸出序列。

如需詳細資訊，請參閱 about_Quoting_Rules。

參數屬性

類型:

String[]

預設值:None
支援萬用字元:False
不要顯示:False
別名:PSPath, LP

參數集

LiteralPath
Position:Named
必要:True
來自管線的值:True
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-Path

指定一或多個 Markdown 命令檔案的路徑。 允許使用通配符字元。

參數屬性

類型:

String[]

預設值:None
支援萬用字元:True
不要顯示:False

參數集

Path
Position:0
必要:True
來自管線的值:True
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-WhatIf

在僅報告將發生的情況而不執行作的模式下運行命令。

參數屬性

類型:SwitchParameter
預設值:False
支援萬用字元:False
不要顯示:False
別名:無線

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

CommonParameters

此 Cmdlet 支援一般參數：-Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction 和 -WarningVariable。 如需詳細資訊，請參閱 about_CommonParameters。

輸入

String

輸出

Microsoft.PowerShell.PlatyPS.Model.CommandHelp

備註

此命令類似於 Update-MarkdownCommandHelp Cmdlet，但它會更新記憶體中的 CommandHelp 物件，而不是更新來源 Markdown 檔案。