Язык и ненужные правила

  • Статья

Правила языка в стиле кода влияют на то, как используются различные конструкции языков программирования .NET, например модификаторы и круглые скобки.

Эта категория также содержит правила, определяющие части базы кода, которые являются ненужными и могут быть рефакторингированы или удалены. Наличие ненужного кода указывает на одну из следующих проблем:

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

Правила языка делятся на следующие категории:

  • Правила стиля .NET в равной мере применяются к C# и Visual Basic. Имена параметров для этих правил начинаются с префикса dotnet_style_.
  • Правила стиля C#: правила, относящиеся к коду C#. Имена параметров для этих правил начинаются с префикса csharp_style_.
  • Правила стиля Visual Basic: правила, относящиеся к коду Visual Basic. Имена параметров для этих правил начинаются с префикса visual_basic_style_.

Формат параметра

Многие правила языка имеют один или несколько связанных параметров для настройки предпочтительного стиля. Например, используйте простую инструкцию using (IDE0063) с соответствующим параметром csharp_prefer_simple_using_statement , который позволяет определить, предпочитаете using ли вы объявление или using оператор. Правило применяет все параметры, которые вы выбираете на указанном уровне, например предупреждение или ошибка.

Параметры языковых правил можно указать в файле конфигурации со следующим форматом:

option_name = value (Visual Studio 2019 и более поздних версий)

or

option_name = value:severity

  • Value

    Для каждого правила языка укажите значение, которое определяет условия выбора соответствующего стиля. Многие правила принимают значение true (предпочитать этот стиль) или false (не предпочитать этот стиль). Другие правила принимают значения when_on_single_line или never.

  • Серьезность (необязательно в Visual Studio 2019 и более поздних версиях)

    Вторая часть правила определяет уровень серьезности правила. В .NET 9 и более поздних версиях уровень серьезности всегда учитывается— то есть внутри среды разработки и во время сборки командной строки. В .NET 8 и более ранних версиях этот параметр серьезности учитывается только внутри идентификаторов разработки, таких как Visual Studio, а не во время сборки.

    Если вы используете пакет SDK для .NET 8 или более раннюю версию и хотите, чтобы серьезность была уважаема во время сборки, это можно сделать одним из двух способов:

    • Задайте значение <AnalysisLevel> или <AnalysisLevelStyle> свойство 9.0 или более поздней версии или значение preview.
    • Задайте уровень серьезности с помощью синтаксиса конфигурации серьезности на основе идентификаторов правила для анализаторов. Синтаксис имеет вид dotnet_diagnostic.<rule ID>.severity = <severity>, например dotnet_diagnostic.IDE0040.severity = warning. Дополнительные сведения см. в разделе об уровне серьезности.

Совет

Начиная с Visual Studio 2019, можно настроить правила стиля кода из меню лампочки быстрых действий после нарушения стиля.

Индекс правила

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

using Параметры директивы

Правила стиля .NET (C# и Visual Basic):

Правила стиля C#:

Параметры блока кода

Правила стиля C#:

Элементы, воплощающие выражение

Правила стиля C#:

Предпочтения уровня выражений

Правила стиля .NET (C# и Visual Basic):

Правила стиля C#:

Правила стиля Visual Basic:

Параметры поля

Правила стиля .NET (C# и Visual Basic):

Параметры языков ключевое слово и типы платформ

Правила стиля .NET (C# и Visual Basic):

Предпочтения относительно модификаторов

Правила стиля .NET (C# и Visual Basic):

Правила стиля C#:

Настройки новой строки

  • Разрешить несколько пустых строк (IDE2000)
  • Разрешить внедренные инструкции в одной строке (IDE2001)
  • Разрешить пустые строки между последовательными скобками (IDE2002)
  • Разрешить оператор сразу после блокировки (IDE2003)
  • Разрешить пустую строку после двоеточия в инициализаторе конструктора (IDE2004)
  • Разрешить пустую строку после маркера в условном выражении (IDE2005)
  • Разрешить пустую строку после маркера в выражении со стрелками (IDE2006)

Параметры проверки NULL

Правила стиля C#:

Предпочтения для параметров

Правила стиля .NET (C# и Visual Basic):

Предпочтения относительно круглых скобок

Правила стиля .NET (C# и Visual Basic):

Параметры сопоставления шаблонов

Правила стиля C#:

Предпочтения подавления

Правила стиля .NET (C# и Visual Basic):

This. и me. настройки

Правила стиля .NET (C# и Visual Basic):

var Предпочтения

Правила стиля C#:

См. также