How do I get a warning in Visual Studio when async methods don't end in 'Async'?
C#Visual StudioAsynchronousC# Problem Overview
How can I get Visual Studio to give me a naming warning each time I create an asynchronous method that doesn't end in "Async"?
It's the recommended convention for asynchronous methods, but I often find myself forgetting to add that suffix and a warning would be useful.
C# Solutions
Solution 1 - C#
From Options,
- Go to Text Editor → Basic → Code Style → Naming
- Select Manage Specifications and Add New Specification
- Select Method, tick all accessibility options and from Modifiers, select Async.
- Give the title as Async Method and save
- Now get into Manage Naming Styles and add New Style. Add Async as suffix and give it a name as AsyncSuffix, and then save
- Now press the plus sign and create new naming. Select specification as Async Method, select required Style as AsyncPostfix and Severity as Suggestor.
- Click OK and save
Solution 2 - C#
In addition to Visual Studio Text Editor Settings, you can create portable, custom editor settings .editorconfig file. Visual Studio 2017 natively supports .editorconfig files.
By creating the .editorconfig file as part of the repository and pushing it to the repository, you can enforce consistent coding styles for everyone that works in that codebase, regardless of their Visual Studio Text Editor Settings.
> The Coding conventions you use on your personal projects may differ from > those used on your team's projects. EditorConfig files resolve this > problem by enabling you to have a configuration for each scenario.
> EditorConfig settings take precedence over global Visual Studio text > editor settings.
To do so:
-
In the Solution Explorer, select the Solution, Project or a folder in the project, depending on the scope which you want to apply the naming rule.
-
Right click and select Add New Item or Press Ctrl + Shift + A
-
Choose Text File file from General categories and enter
.editorconfigas file name.
Note: The file location can be even in parent folder of your solution. It's not necessary to have it in solution.
Paste the following content in the file:
# 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 =
More Information:
Solution 3 - C#
The Microsoft.VisualStudio.Threading.Analyzers analyzer offers this
under the rule VSTHRD200
More info here https://github.com/microsoft/vs-threading/blob/main/doc/analyzers/VSTHRD200.md
tl;dr:
<PackageReference Include="Microsoft.VisualStudio.Threading.Analyzers" Version="17.1.46">
<PrivateAssets>all</PrivateAssets>
<IncludeAssets>runtime; build; native; contentfiles; analyzers</IncludeAssets>
</PackageReference>