Как получить предупреждение в Visual Studio, когда асинхронные методы не заканчиваются на "асинхронные"?

Как я могу заставить Visual Studio выдавать мне предупреждение об именах каждый раз, когда я создаю асинхронный метод, который не заканчивает "Асинхронизация"?

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

Ответы

Ответ 1

Из опций,

  • Перейдите в текстовый редактор → Основные → Стиль кода → Именование
  • Выберите "Управление спецификациями" и "Добавить новую спецификацию".
  • Выберите "Метод", отметьте все опции специальных возможностей и в "Модификаторах" выберите "Асинхронный".
  • Дайте название Async Method и сохраните
  • Теперь зайдите в Управление стилями именования и добавьте новый стиль. Добавьте Async в качестве суффикса и присвойте ему имя AsyncSuffix, а затем сохраните
  • Теперь нажмите знак плюс и создайте новое имя. Выберите спецификацию в качестве асинхронного метода, выберите требуемый стиль в качестве AsyncPostfix и серьезность в качестве подсказки.
  • Нажмите OK и сохраните

Enter image description here

Enter image description here

Enter image description here

Ответ 2

В дополнение к настройкам текстового редактора Visual Studio вы можете создать переносной файл пользовательских настроек редактора .editorconfig. Visual Studio 2017 изначально поддерживает файлы .editorconfig.

Создав файл .editorconfig как часть репозитория и отправив его в репозиторий, вы можете применять согласованные стили кодирования для всех, кто работает в этой кодовой базе, независимо от их настроек текстового редактора Visual Studio.

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

Настройки EditorConfig имеют приоритет над глобальным текстом Visual Studio Настройки редактора.

Для этого:

  1. В обозревателе решений выберите Решение, Проект или папку в проекте в зависимости от области, к которой вы хотите применить правило именования.

  2. Щелкните правой кнопкой мыши и выберите "Добавить новый элемент" или нажмите Ctrl + Shift + A

  3. Выберите файл текстового файла из общих категорий и введите .editorconfig в качестве имени файла.

Примечание. расположение файла может быть даже в родительской папке вашего решения. Не обязательно иметь это в решении.

Вставьте следующее содержимое в файл:

# Top-most EditorConfig file
root = true

[*.{cs,vb}]

# Async methods should have "Async" suffix
dotnet_naming_rule.async_methods_end_in_async.symbols = any_async_methods
dotnet_naming_rule.async_methods_end_in_async.style = end_in_async
dotnet_naming_rule.async_methods_end_in_async.severity = suggestion

dotnet_naming_symbols.any_async_methods.applicable_kinds = method
dotnet_naming_symbols.any_async_methods.applicable_accessibilities = *
dotnet_naming_symbols.any_async_methods.required_modifiers = async

dotnet_naming_style.end_in_async.required_prefix = 
dotnet_naming_style.end_in_async.required_suffix = Async
dotnet_naming_style.end_in_async.capitalization = pascal_case
dotnet_naming_style.end_in_async.word_separator =

Дополнительная информация: