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

Question

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

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

Answer 1

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

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

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

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

Комусделайте так:

1. В Solution Explorer выберите Solution, Project или папку в проекте, в зависимости от области действия, к которой вы хотите применить правило именования..

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 = 

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

• Создавайте переносимые пользовательские настройки редактора с помощью EditorConfig
• EditorConfig

Answer 2

Из Параметры ,

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