Update-CommandHelp

模块:

Microsoft.PowerShell.PlatyPS Module

使用同名会话 cmdlet 中的信息更新导入的 CommandHelp 对象。

语法

Path （默认值）

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

LiteralPath

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

说明

此 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 文件。

相关链接

• Update-MarkdownCommandHelp