Внесите вклад в документацию по правилам анализа кода .NET

Анализаторы платформы компилятора .NET (Roslyn) проверяют код C# или Visual Basic для проблем с качеством кода и стилем кода. Эти анализаторы включены в пакет SDK для .NET.

• Анализ качества кода (правила CAxxxxx):
  • Реализовано в репозитории dotnet/sdk (ранее реализовано в dotnet/roslyn-analyzers репозитории).
  • Документирован здесь в репозитории dotnet/docs . Пожалуйста, ознакомьтесь с документацией по добавлению правил 'CAxxxx'.
• Анализ стиля кода (правила IDExxxxx):
  • Реализовано в репозитории dotnet/roslyn .
  • Документирован здесь в репозитории dotnet/docs . См. документацию о правилах «IDExxxx».

Предоставьте документацию для правил 'CAxxxx'

Выполните следующие действия, чтобы внести документацию по правилам анализа качества кода в репозиторий dotnet/docs :

1. Определите Rule ID и Category: убедитесь, что вы знаете идентификатор правила 'CAxxxx' и категорию, к которой относится это правило. Это означает, что анализатор ЦС был объединен в репозиторий dotnet/sdk или у вас есть открытый PR с утвержденным идентификатором и категорией, назначенной правилу.
2. Добавьте документ правила:
   1. Клонируйте существующий файл правила ЦС в корневой папке, скажем ca1000.md, и переименуйте его.
   2. Обновите содержимое файла соответствующим образом.
3. Добавьте запись для правила в следующие таблицы:
   • В файле оглавления в списке категорий правил. Например, для правила ЦС с Performance категорией найдите термин - name: Performance rules в файле и добавьте запись в список. Если нет, создайте список категорий в разделе - name: Code quality rules.
   • В файле индекса верхнеуровневых правил .
   • В файле индекса правила на category основе:
     1. Определите файл индекса на основе категорий в корневой папке. Например, для правила ЦС с Performance категорией этот файл называется performance-warnings.md. Если нет, создайте файл индекса на основе категорий путем клонирования существующего.
     2. Добавьте запись для идентификатора правила в этом файле.

Предоставьте документацию для правил IDExxxx.

Выполните следующие действия, чтобы внести документацию по правилам анализа стиля кода в репозиторий dotnet/docs :

1. Определите Rule ID и параметры стиля кода, если таковые есть: убедитесь, что вы знаете идентификатор правила IDExxxx и параметры стиля кода для документированного правила. Это означает, что анализатор интегрированной среды разработки был объединен в репозиторий dotnet/roslyn или у вас есть открытый PR с утвержденными параметрами идентификатора и стиля кода, назначенными правилу.
2. Определение правила subcategory: правила интегрированной среды разработки имеют категорию Style. Определите подкатегорию правила, прочитайте вводный раздел правил стиля кода. Большинство правил стиля кода интегрированной среды разработки находятся в Language подкатегории.
3. Определите правило preference group: определите preference group для правила, прочитав здесь заголовки параметров.
   • Если правило имеет известные, связанные с ним параметры стиля кода, группа предпочтений будет соответствовать тем, которые указаны в объявлении параметра стиля кода.
   • В противном случае определите, принадлежит ли правило существующей группе предпочтений или требуется новая группа предпочтений.
4. Добавьте документ правила:
   1. Клонируйте существующий файл правил интегрированной среды разработки в корневой папке, скажем ide0011.md, и переименуйте его.
   2. Обновите содержимое файла соответствующим образом.
5. Добавьте запись для правила интегрированной среды разработки и (или) вариантов стиля кода в следующие таблицы:
   • В файле содержания в подкатегории правила и списке параметров. Например, для правила стиля кода IDE с Language подкатегорией и Modifier preferences группой найдите термин - name: Language rules и дочерний узел - name: Modifier preferences в файле и добавьте запись в список. Если список подкатегорий или список параметров в подкатегории не существует, создайте новую подкатегорию - name: Code style rules.
   • В файле индекса стиля кода.
   • В файле индекса по идентификатору правила.
   • В файле индекса правила на preferences group основе:
     1. Определите файл индекса на основе группы настроек в корневой папке. Например, для правила Modifier preferencesинтегрированной среды разработки этот файл называется modifier-preferences.md. Если нет, создайте файл индекса на основе группы настроек путем клонирования существующего.
     2. Добавьте запись для идентификатора правила в этом файле.

См. также

• Участие в репозиториях документации .NET