每当我创建不以“异步”结尾的异步方法时,如何使Visual Studio发出命名警告?
这是异步方法的推荐约定,但我经常发现自己忘了添加后缀,并且警告会很有用。
每当我创建不以“异步”结尾的异步方法时,如何使Visual Studio发出命名警告?
这是异步方法的推荐约定,但我经常发现自己忘了添加后缀,并且警告会很有用。
.editorconfig
文件来进行操作,仅限于警告带有async
修饰符的方法,而不能将规则应用于return的方法Task
。
...Async
以该名称使用匈牙利表示法!
Answers:
Task
但不直接等待)。
除了Visual Studio文本编辑器设置,您还可以创建可移植的自定义编辑器设置.editorconfig
文件。Visual Studio 2017本机支持.editorconfig
文件。
通过将.editorconfig
文件作为存储库的一部分创建并将其推送到存储库,您可以为在该代码库中工作的每个人实施一致的编码样式,无论其Visual Studio文本编辑器设置如何。
您在个人项目中使用的编码约定可能与团队项目中使用的编码约定不同。EditorConfig文件通过使您能够为每个方案进行配置来解决此问题。
EditorConfig设置优先于全局Visual Studio文本编辑器设置。
为此:
在“解决方案资源管理器”中,根据要应用命名规则的范围,选择“解决方案”,“项目”或项目中的文件夹。
右键单击并选择添加新项或按Ctrl+ Shift+A
.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
文件拖放到与文件相同的目录中.sln
,即可对其进行检测。