如何在 C# 中将特定参数标记为已过时/已弃用？

Question

我希望能够保持 C# API 与现在相同，但只需弃用方法调用中的参数之一。是否可以这样做，或者我是否需要创建一个不带参数的新方法并将原始方法标记为已过时？

Answer 1

简短回答：

您需要使用新签名创建一个新方法，并将当前方法标记为已过时。

更长的答案

您要不惜一切代价避免的是代码破坏！然后，特别是在公司框架中，例如，您想宣传您的方法将不再受支持，但您不想为依赖解决方案因架构或设计决策或您这边的崩溃而负责，对吗？

ObsoleteAttribute 类将执行以下操作给你的伎俩。

一旦某个类成员被标记为过时，客户端、使用您框架的用户、甚至同一项目下的同事都会发出警告，以继续这种方式。

public class MyClass {
    [Obsolete("This method should no longer be used, please use MyNewMethod() instead.")]
    public void MyMethod(string name, long phoneNumber, long faxNumber) { 
    }

    public void MyNewMethod(string name, long phoneNumber, long faxNumber, string email) { 
    }
}

这将通告您的代码用户不再支持 MyMethod。

经过一段时间后，足够合理地允许每个人更改他/她的代码，当代码中仍然使用过时的方法时，您可以告诉此属性抛出错误消息。

public class MyClass {
    [Obsolete("This method should no longer be used, please use MyNewMethod() instead.", true)]
    public void MyMethod(string name, long phoneNumber, long faxNumber) { 
    }

    public void MyNewMethod(string name, long phoneNumber, long faxNumber, string email) { 
    }
}

通过将第二个 ObsoleteAttribute 类构造函数参数设置为 true，您可以告诉编译器将此方法的使用作为错误进行通告。

一段时间后，您可以从代码中完全删除您的方法，以稍微清理一下。这是敏捷软件开发方法论鼓励的重构方法的一部分。

这有帮助吗？

Answer 2

是的，我认为唯一的方法是创建一个不带参数的新方法，并用 ObsoleteAttribute 标记原始方法。

Answer 3

使用 Obsolete 属性：

[Obsolete("Please use void AnotherMethod() instead", false)]
void SomeMethod(Int32 data){
}

属性中的布尔值告诉编译器生成警告，如果将其更改为 true，编译器将生成错误。有关相关文档，请参阅此处。

Answer 4

是的。您只能将类型和类型成员标记为过时，而不能个别参数。但是，您可以重载该方法，从而保持相同的名称并将旧方法标记为已过时：

class Act
{
    [Obsolete("DoSomething(int, int) is obsolete", false /*warn only*/)]
    public void DoSomething(int i, int j)
    {
    }

    public void DoSomething(int i)
    {
    }
}

Answer 5

我认为最好创建一种新方法。

使参数过时是什么意思？这是否取决于该参数的具体值？当你调用一个方法时，你总是必须指定参数。