2

假设您有旧的、已弃用的参数集和一个新的参数集：

SYNTAX
    Get-FooBar -SomeCommonParameter <string> -NewParameter <NewResourceType>

    Get-FooBar -SomeCommonParameter <string> -OldParameter <OldResourceType>

我希望两个参数集继续工作，以保持与现有脚本的兼容性，但我不希望旧的不推荐使用的参数集出现在Get-Help输出中。或者，至少，在 的SYNTAX部分中明确标记为已弃用Get-Help。

PowerShell 4.0 中的参数属性的DontShow属性有点帮助，因为那时 IntelliSense/tab 补全不会使用它，但参数集仍然出现在Get-Help输出中。

我们目前使用的是 PowerShell 3.0，但我不认为更新我们的目标 PowerShell 版本会成为障碍。

4

1 回答 1

3

您是在更改名称，还是功能也不同？如果您只是更改名称，请将新名称作为参数名称和alias旧名称。

如果您还要更改功能，该dbatools模块将执行以下操作：

  • 在基于注释的帮助中指出该参数已被弃用（在描述该参数之前）
  • 使用内部函数测试不推荐使用的参数名称，并在用户使用过参数名称时向用户提供警告消息。

示例： 从其块Get-DbaDiskSpace调用。解析函数调用以查找传入（已弃用）参数名称的用法。Test-DbaDeprecationbeginTest-DbaDeprecation

于 2018-01-05T12:34:48.037 回答