Уведомить разработчика о методе «НЕ ИСПОЛЬЗОВАТЬ»

Прочитал заголовок и сразу подумал «устаревший атрибут». Как насчет

    /// <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) { 
    ....

ObsoleteAttribute, вероятно, будет работать в вашей ситуации - вы даже можете вызвать сбой сборки, если использовать этот метод.

Поскольку устаревшие предупреждения возникают во время компиляции и поскольку отражение, необходимое для сериализации, происходит во время выполнения, отметка этого метода как устаревшего не нарушит сериализацию, но предупредит разработчиков, что метод не существует для использования.

Вы ищете класс 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() { }
}

Да, есть.

Я написал об этом в блоге Работа с дизайнером.

А вот код:

public class MyClass
{
  [Obsolete("reason", true)]
  public MyClass()
  {
    // required for xml serialization
  }
}

Я использую ObsoleteAttribute.

Но также, конечно, вы можете сделать несколько комментариев.

И, наконец, удалите его полностью, если можете (не обязательно поддерживать совместимость с чем-то старым). Это лучший способ.

Вау, эта проблема меня тоже беспокоит.

Вам также нужны конструкторы по умолчанию для NHibernate, но я хочу заставить людей НЕ использовать инициализаторы объектов C# 3.0, чтобы классы проходили через код конструктора.

Если класс - [Serialisable] (т.е. он может быть скопирован в любое место по мере необходимости), для десериализации необходим конструктор без параметров.

Я предполагаю, что вы хотите, чтобы доступ вашего кода передавал значения по умолчанию для ваших свойств параметризованному конструктору.

По сути, вы говорите, что XmlSerializer может сделать копию, а затем установить свойства, но вы не хотите, чтобы это делал ваш собственный код.

В некоторой степени я думаю, что это чрезмерный дизайн.

Просто добавьте XML-комментарии, подробно описывающие, какие свойства нужно инициализировать (и что именно).

Не используйте [Obsolete], потому что это не так. Зарезервируйте это для действительно устаревших методов.

На самом деле я был бы склонен не согласиться со всеми, кто выступает за использование ObsoleteAttribute, поскольку в документации MSDN говорится, что:

Marking an element as obsolete informs the users that the element will be removed in future versions of the product.

Поскольку универсальные конструкторы для сериализации XML не следует удалять из приложения, я бы не стал применять их на всякий случай, если разработчик обслуживания в будущем не знаком с тем, как работает сериализация XML.

На самом деле я использовал метод Кита, просто отмечая, что конструктор используется для сериализации в документации XML, чтобы он отображался в Intellisense.

Вы можете использовать:

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

чтобы он не отображался в Intellisence. Если потребитель все еще хочет использовать его, он может, но он не будет таким заметным.

Тем не менее, точка зрения Кейтса о инженерии остается в силе.

Вы можете создать свой собственный производный класс Attribute, скажем NonCallableAttribute, чтобы квалифицировать методы, а затем добавить к своей задаче анализа кода сборки / CI проверку, чтобы отслеживать, использует ли какой-либо код эти методы.

На мой взгляд, вы действительно не можете заставить разработчиков не использовать этот метод, но вы можете как можно скорее обнаружить, когда кто-то нарушил правило, и исправить это.

throw new ISaidDoNotUseException();

Отделите сериализуемый объект от объекта домена.

Хороших ответов уже достаточно много. Но я думаю, что лучший вариант - использовать сериализатор, который может использовать параметризованный конструктор. Вам не нужен сериализатор, но, например, Entity Framework Core знает, как использовать параметризованные конструкторы.

Документация Entity Framework Core:

If EF Core finds a parameterized constructor with parameter names and types that match those of mapped properties, then it will instead call the parameterized constructor with values for those properties and will not set each property explicitly.