通知开发人员“请勿使用”方法

VS2013之前 您可以使用:

[ System.ComponentModel.EditorBrowsable ( System.ComponentModel.EditorBrowsableState.Never )]

这样它就不会出现在IntelliSense中。如果消费者仍然想使用它,他们可以,但它不会那么容易被发现。

Keith's point 不过,过度工程仍然存在。

自VS2013以来 此功能已被删除。如所述 https://github.com/dotnet/roslyn/issues/37478 这是“故意的”,显然不会再回来了。

如果一个类是 [Serialisable] (即,可以根据需要在该位置进行复制)需要无参数构造函数进行反序列化。

我猜你想强制代码访问,将属性的默认值传递给参数化构造函数。

基本上你是说这对 XmlSerializer 创建一个副本,然后设置属性,但您不希望自己的代码这样做。

在某种程度上,我认为这是过度设计。

只需添加XML注释,详细说明需要初始化哪些属性(以及需要初始化什么)。

不使用 [Obsolete] ,因为它不是。将其保留给真正弃用的方法。

throw new ISaidDoNotUseException();

你可以建立自己的 Attribute 派生类,比如 NonCallableAttribute 以限定方法,然后将检查添加到构建/CI代码分析任务中,以监视是否有任何代码正在使用这些方法。

在我看来,你真的不能强迫开发人员不使用这种方法,但你可以尽快发现有人违反了规则并加以修复。

实际上,我倾向于不同意所有主张使用 ObsoleteAttribute 正如MSDN文档所说:

将元素标记为过时会通知用户该元素将在产品的未来版本中删除。

由于XML序列化的通用构造函数不应从应用程序中删除,因此我不会应用它,以防未来的维护开发人员不熟悉XML序列化的工作原理。

我实际上一直在使用 Keith's 只需注意构造函数用于XML文档中的序列化,以便它显示在Intellisense中。

现在你可以使用 代码分析器 为了满足这样的需求,这要归功于现代的Roslyn编译器。网。

您可以编写自己的代码分析器。以下是一些建议:

• https://learn.microsoft.com/en-us/dotnet/csharp/roslyn-sdk/tutorials/how-to-write-csharp-analyzer-code-fix
• https://andrewlock.net/creating-a-roslyn-analyzer-in-visual-studio-2017/
• https://www.meziantou.net/writing-a-roslyn-analyzer.htm

或者使用一些已经存在的——这是我根据自己的需求选择的方式:

• BannedApiAnalzyers - 这正是“请勿使用”警告

这是Roslyn Analyzers的另一个不错的“主页”: Cybermaxs/出色的分析器:精心策划的列表。NET编译器平台(“Roslyn”)诊断分析器和代码修复。每个人都可以在这里做出贡献! https://github.com/Cybermaxs/awesome-analyzers

我读了标题,立刻想到“过时的属性”。怎么样

    /// <summary>
    /// do not use
    /// </summary>
    /// <param name="item">don't pass it anything -- you shouldn't use it.</param>
    /// <returns>nothing - you shouldn't use it</returns>
    public bool Include(T item) { 
    ....

将可序列化对象与域对象分离。

哇,这个问题也困扰着我。

您还需要NHibernate的默认构造函数,但我想强制人们不要使用C#3.0对象初始化器,这样类才能通过构造函数代码。

你要找的是 ObsoleteAttribute 类别:

using System;

public sealed class App {
   static void Main() {      
      // The line below causes the compiler to issue a warning:
      // 'App.SomeDeprecatedMethod()' is obsolete: 'Do not call this method.'
      SomeDeprecatedMethod();
   }

   // The method below is marked with the ObsoleteAttribute. 
   // Any code that attempts to call this method will get a warning.
   [Obsolete("Do not call this method.")]
   private static void SomeDeprecatedMethod() { }
}

ObsoleteAttribute 可能会在你的情况下奏效——如果使用这种方法,你甚至可以导致构建中断。

由于过时的警告发生在编译时,并且序列化所需的反射发生在运行时,因此标记该方法过时不会破坏序列化,但会警告开发人员该方法不可用。

我在用 ObsoleteAttribute .

当然,你也可以发表一些评论。

最后,如果可以的话,完全删除它(不必保持与旧东西的兼容性)。这是最好的办法。