Поделиться через

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

  • Статья

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

В этом разделе

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