Правила документирования

  • Статья

Правила документации поддерживают написание хорошо задокументированных библиотек путем правильного использования комментариев XML-документации для видимых извне API-интерфейсов.

Содержание раздела

Правило Описание
CA1200: Избегайте использования тегов cref с префиксом Атрибут cref в теге XML-документации означает "code reference" (кодовая ссылка). Он указывает, что текст внутри тега представляет собой элемент кода, например тип, метод или свойство. Старайтесь не использовать теги cref с префиксами, так как это не позволяет компилятору проверять ссылки. Это также мешает поиску и обновлению этих символьных ссылок во время рефакторинга в интегрированной среде разработки (IDE) Visual Studio.