Параметры стиля кода

Параметры стиля кода можно определить с помощью файла EditorConfigили для всего кода, редактируемого в Visual Studio, на странице параметров текстового редактора . Для кода C# можно также настроить Visual Studio для применения этих настроек стиля кода с помощью команд очистки кода (Visual Studio 2019, Visual Studio 2022) и форматирования документа (Visual Studio 2017).

Стили кода в файлах EditorConfig

параметры стиля кода для .NET можно указать, добавив в проект файл EditorConfig. Файлы EditorConfig связаны с базой кода, а не учетной записью персонализации Visual Studio. Параметры в файле EditorConfig имеют приоритет над стилями кода, указанными в диалоговом окне Параметры. Используйте файл EditorConfig, если вы хотите применить стили написания кода для всех участников репозитория или проекта.

Вы можете вручную заполнить файл EditorConfig или автоматически создать файл на основе параметров стиля кода, выбранных в диалоговом окне "Параметры Visual Studio". Эта страница параметров доступна в меню "Средства>Параметры>Текстовый редактор> [C# или Basic] >Настройка стиля кода>Общие. Щелкните Создать файл .editorconfig из настроек, чтобы автоматически сгенерировать файл .editorconfig на основе настроек на этой странице Параметры.

снимок экрана: создание файла editorconfig из параметров.

Вы можете вручную заполнить файл EditorConfig или автоматически сгенерировать его на основе выбранных вами параметров стиля кода в диалоговом окне «Параметры Visual Studio» . Эта страница параметров доступна на Инструменты>Параметры>Текстовый редактор> [C# или Visual Basic] >Стиль кода>Общие. Щелкните Создать файл editorconfig из параметров, чтобы автоматически создать файл .editorconfig на основе параметров на этой странице параметров.

снимок экрана: создание файла editorconfig из параметров.

Стили кода в диалоговом окне "Параметры"

Параметры стиля кода можно задать для всех проектов C# и Visual Basic, открыв диалоговое окно "Параметры " в меню "Сервис". В диалоговом окне "Параметры" выберите текстовый редактор> [C# или Visual Basic] >стиль кода>Общие.

Параметры стиля кода можно задать для всех проектов C# и Visual Basic, открыв диалоговое окно "Параметры " в меню "Сервис". В диалоговом окне Параметры выберите Текстовый редактор> [C# или Базовый] >Стиль кодаОбщие>.

Каждый элемент в списке отображает предварительный просмотр предпочтений при выборе:

снимок экрана параметров стиля кода.

Снимок экрана параметров стиля кода.

Параметры, заданные в этом окне, применимы к учетной записи персонализации Visual Studio и не связаны с определенным проектом или базой кода. Кроме того, они не применяются во время сборки, включая сборки непрерывной интеграции (CI). Если вы хотите связать параметры стиля кода с проектом и применить стили во время сборки, укажите параметры в файле .editorconfig, связанном с проектом.

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

Для каждого параметра стиля кода на этой странице вы можете задать предпочтительный параметр и уровень значимости с помощью раскрывающихся списков в каждой строке. Уровень серьезности можно задать для Только рефакторинг, предложения, предупрежденияили ошибки. Если вы хотите включить быстрые действия для стиля кода, убедитесь, что для параметра уровня важности задано значение, отличное от Только рефакторинг. быстрые действия лампочки , лампочки ошибок или значок отвертки отображается, если используется не предпочтительный стиль, и вы можете выбрать вариант в списке быстрых действий, чтобы автоматически переписать код в предпочитаемый стиль.

Принудительное применение стилей кода при сборке

Начиная с Visual Studio 2019 версии 16.8, которая включает пакет SDK для .NET 5.0 RC2, вы можете применить соглашения о программировании .NET для сборки для всех проектов .NET. Во время сборки нарушения стиля кода .NET будут отображаться в виде предупреждений или ошибок с префиксом IDE. Это позволяет строго применять согласованные стили кода в базе кода.

Применение стилей кода

Для файлов кода C# в Visual Studio есть кнопка Код очистки в нижней части редактора (клавиатура: Ctrl +K, Ctrl+E) для применения стилей кода из файла "EditorConfig" или на странице параметров Код стиля. Если файл .editorconfig существует для проекта, это параметры, которые имеют приоритет.

Совет

Правила, настроенные с уровнем серьёзности None, не участвуют в очистке кода, но могут применяться по отдельности с помощью меню Быстрых действий и Реорганизации кода.

Чтобы применить стили кода, выполните указанные ниже действия.

  1. Сначала настройте стили кода, которые необходимо применить (в одном из двух профилей) в диалоговом окне Настройка очистки кода. Чтобы открыть это диалоговое окно, щелкните стрелку-развертку рядом с значком метлы для очистки кода, а затем выберите Настроить очистку кода.

    снимок экрана: настройка очистки кода.

  2. После настройки очистки кода используйте один из следующих методов для запуска очистки кода:

    • Щелкните значок метлы или нажмите Ctrl +K, Ctrl+E, чтобы запустить очистку кода.

      Скриншот: выполнение очистки кода.

    • Чтобы выполнить очистку кода во всем проекте или решении, щелкните правой кнопкой мыши имя проекта или решения в обозревателе решений, выберите Анализ и очистка кода, а затем выберите Выполнить очистку кода.

      снимок экрана запуска очистки кода во всем проекте или решении.

    Если вы хотите, чтобы параметры стиля кода применялись при каждом сохранении файла, вы можете использовать расширение Code Cleanup on Save extension.

Для файлов кода C# в Visual Studio есть кнопка очистка кода в нижней части редактора (клавиатура: клавиша CTRL +K, CTRL+E) для применения стилей кода из файла EditorConfig или на странице параметров стиля кода. Если файл .editorconfig существует для проекта, это параметры, которые имеют приоритет.

Совет

Правила, настроенные с серьезностью None, не участвуют в очистке кода, но могут применяться по отдельности с помощью меню Быстрые действия и рефакторинг.

Чтобы применить стили кода, выполните указанные ниже действия.

  1. Сначала настройте стили кода, которые необходимо применить (в одном из двух профилей) в диалоговом окне Настройка очистки кода. Чтобы открыть это диалоговое окно, щелкните стрелку расширения рядом с значком очистки метки кода, а затем выберите Настроить очистку кода.

    Снимок экрана настройки очистки кода.

  2. После настройки очистки кода используйте один из следующих методов для запуска очистки кода:

    • Щелкните значок метлы или нажмите клавиши Ctrl+K, Ctrl+E.

      снимок экрана: очистка исполняемого кода.

    • Чтобы выполнить очистку кода во всем проекте или решении, щелкните правой кнопкой мыши имя проекта или решения в обозревателе решений, выберите Анализ и очистка кода, а затем выберите Выполнить очистку кода.

      снимок экрана функции

    Если вы хотите, чтобы параметры стиля кода применялись при каждом сохранении файла, перейдите в раздел Параметры>Текстовый редактор>Очистка кода и выберите Запускать профиль очистки кода при сохранении.

Параметры очистки кода

Большинство параметров очистки кода сопоставляется с одним или несколькими стилями кода .NET, поддерживаемыми в .editorconfig. Чтобы увидеть примеры, показывающие эффекты параметров, используйте ссылки в следующей таблице.

Настройки Параметр "Идентификатор правила" или "Стиль"
Удаление ненужных импортов или использования IDE0005
Сортировка импорта или использования dotnet_sort_system_directives_first
dotnet_separate_import_directive_groups
Применение параметров заголовка файла file_header_template
Удаление неиспользуемых переменных CS0219
Применение параметров создания объектов стиль_VisualBasic_предпочитать_упрощенное_создание_объектов
Применить настройки IsNot visual_basic_style_prefer_isnot_expression
Добавление квалификации "это" или "Я" IDE0003-IDE0009
Добавить модификаторы доступности dotnet_style_require_accessibility_modifiers
Модификаторы порядка IDE0036
Сделать поле доступным только для чтения dotnet_style_readonly_field
Удаление ненужных приведения IDE0004
Применение параметров инициализации объекта или коллекции) dotnet_style_object_initializer
Применение предпочтений размещения директив csharp_using_directive_placement
Применение настроек круглых скобок IDE0047-IDE0048
Применение неиспользуемых настроек значений IDE0058
Применение предпочтений типа языка/фреймворка IDE0049
Удаление неиспользуемых подавлений dotnet_remove_unnecessary_suppression_exclusions
Применение предпочтений для упрощения булевых выражений dotnet_style_prefer_simplified_boolean_expressions
Применение параметров интерполяции строк dotnet_style_prefer_simplified_interpolation
Удаление неиспользуемых параметров dotnet_code_quality_unused_parameters
Настройка предпочтений автоматических свойств dotnet_style_prefer_auto_properties
Применение параметров составного назначения dotnet_style_prefer_compound_assignment
Применение параметров функции объединения dotnet_style_coalesce_expression
Применение предпочтений для условных выражений dotnet_style_prefer_conditional_expression_over_assignment
dotnet_style_prefer_conditional_expression_over_return
Применение параметров имени кортежа dotnet_style_explicit_tuple_names
dotnet_style_prefer_inferred_tuple_names
Примените предпочтения для имен элементов анонимного типа, определяемых по умолчанию dotnet_style_prefer_inferred_anonymous_type_member_names
Применение параметров проверки null dotnet_style_prefer_is_null_check_over_reference_equality_method
Применение параметров распространения NULL dotnet_style_null_propagation
Примените настройки var IDE0007-IDE0008
Добавьте обязательные фигурные скобки для операторов управления в одну строку csharp_prefer_braces
Применение параметров выражения или блока текста членов с выражением
Применение предпочтений встроенных в строке переменных out csharp_style_inlined_variable_declaration
Применение параметров сопоставления шаблонов настройки сопоставления шаблонов
Применить настройки вызова условного делегата csharp_style_conditional_delegate_call
Примените предпочтения для статических локальных функций csharp_prefer_static_local_function
Применение параметров деконструкции csharp_style_deconstructed_variable_declaration
Применение параметров по умолчанию (T) csharp_prefer_simple_default_expression
Применение параметров new() csharp_style_implicit_object_creation_when_type_is_apparent
Применить предпочтения диапазона csharp_style_prefer_range_operator
Отдавайте предпочтение локальным функциям над анонимными. csharp_style_pattern_local_over_anonymous_function
Применение предпочтений параметра null настройки проверки на null
Применение параметров инструкции using предпочтение_упрощённого_использования_оператора_using_в_csharp
Применение параметров выражения throw csharp_style_throw_expression

::: moniker-end