Реализации интерфейсов — без XML-доков (код-стайл)

2026-09-13 04:17:44 +03:00
parent a9d26b6ffc
commit 94fdfeb4e5
1 changed files with 6 additions and 3 deletions
@@ -250,9 +250,12 @@

 ## 11. Интерфейсы

- **Не дублировать `<summary>` интерфейса в реализации.** Если член объявлен в интерфейсе с XML-doc,
-  в классе-реализации достаточно `/// <inheritdoc/>` (или вообще ничего, если doc наследуется настройкой).
-  Текст описания пишется **один раз** — у интерфейса.
+- **В реализациях интерфейсов XML-doc не пишем вообще.** Если тип или член объявлен в интерфейсе,
+  класс-реализация не документируется: ни `<summary>`, ни `<inheritdoc/>` (и ни `<param>` на
+  конструкторе). Описание живёт **один раз** — в интерфейсе; реализации вызываются только через порт.
+  Под этот запрет попадает и сам класс-реализация (его `<summary>` тоже лишний — есть у интерфейса).
+- **XML-doc уместен только там, где нет интерфейса:** public-типы/члены без порта (статика, константы,
+  extension-классы), `protected`-члены и DTO/модели. **[изм. 2026-09-13, решение владельца]**
 - **Явная реализация интерфейсов — по умолчанию** (`Task ICardStore.GetAsync(...)`). **[изм. 2026-09-11,
  решение владельца]** Классы напрямую не вызываются — только через интерфейсы; исключения: DTO/модели
  (напр. `Card` и семейство `I*Card`), хелперы, extension-классы. Весь прод-код уже переведён на явные