Compare-CommandHelp

比较两个 CommandHelp 对象,并生成显示差异的详细报告。

语法

__AllParameterSets

Compare-CommandHelp
    [-ReferenceCommandHelp] <CommandHelp>
    [-DifferenceCommandHelp] <CommandHelp>
    [-PropertyNamesToExclude <string[]>]
    [<CommonParameters>]

说明

Compare-CommandHelp 是一种故障排除工具,用于比较两个 CommandHelp 对象并生成显示差异的详细报告。 例如,可以使用此方法比较从不同源导入的对象,例如两个不同的 Markdown 文件版本。

示例

示例 1

$refcmd = Import-MarkdownCommandHelp -Path .\v1\Microsoft.PowerShell.PlatyPS\Compare-CommandHelp.md
$diffcmd = Import-MarkdownCommandHelp -Path .\v2\Microsoft.PowerShell.PlatyPS\Compare-CommandHelp.md
Compare-CommandHelp -ReferenceCommandHelp $refcmd -DifferenceCommandHelp $diffcmd > .\diff.log

参数

-DifferenceCommandHelp

要与引用对象进行比较的 CommandHelp 对象。

参数属性

类型:Microsoft.PowerShell.PlatyPS.Model.CommandHelp
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:1
必需:True
来自管道的值:False
来自管道的值(按属性名称):True
来自剩余参数的值:False

-PropertyNamesToExclude

要从比较中排除的一个或多个属性名称的列表。

参数属性

类型:

String[]

默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-ReferenceCommandHelp

要与差异对象进行比较的基本 CommandHelp 对象。

参数属性

类型:Microsoft.PowerShell.PlatyPS.Model.CommandHelp
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:0
必需:True
来自管道的值:False
来自管道的值(按属性名称):True
来自剩余参数的值:False

CommonParameters

此 cmdlet 支持通用参数:-Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction 和 -WarningVariable。 有关详细信息,请参阅 about_CommonParameters

输入

Microsoft.PowerShell.PlatyPS.Model.CommandHelp

输出

String