Question

在我的项目中，我们需要遵循Web Api的一些编码。我们有什么办法可以在Resharper中配置这些指令吗？我正在使用Resharper Ultimate版。我们也可以配置resharper这样一种方式，如果没有遵循这些指令那么它将抛出错误并显示建议。

指南包含如下通用指令：

Use Camel case in Payload
    Use camel case for the data elements in the payload.    Eg:firstName,lastName                                                                                                                                                 
Use lowercase in Endpoints
    Use only lower case when defining the endpoints.                
    Eg:  GET \api\v1\customers\{CustomerID}\rewards                                                                

Use hyphen for compound words in Endpoints
    Use hyphen for compound words in Endpoints.                 
    Eg: GET \api\v1\customers\{CustomerId}\order-history    

Use Nouns not verbs 
    Noun based endpoint should be used rather than verb based endpoint for CRUD operations.                                              
    Eg:     GET \api\v1\\customers, GET \api\v1\customers\{CustomerID}                                                        
            GET \api\v1\GetAllCustomers

Use verb followed by noun in case of certain functions.                                    
    Eg: PUT \api\v1\customers\{CustomerID}\send-email

Answer 1

我相信你正在寻找StyleCop及其Resharper插件。 StyleCop＆＃34;分析C＃源代码以强制执行一组样式和一致性规则＆＃34;，包括您自己可以编写的规则。

https://github.com/StyleCop

Answer 2

如果从Visual-Studio中的Resharper打开“选项”菜单，则可以配置此类内容。如果滚动到选项列表的底部，您可以找到支持的每种语言的不同节点。在那里，您可以配置大写，小写或大括号布局。屏幕截图显示了C＃的一些约定。

我不知道为此启用错误通知的方法。但是有一个快捷方式，它将您配置的样式用于整个文件（在我的情况下为Strg + E + F）。因此，如果某人没有使用您的约定并且您打开了他的类，您只需按下该组合并对文档进行样式设置。也许这也可以通过Jenkins或sth集成到Build-Processes中。但我还没试过这个。

如果您转到Resharper-＆gt;管理选项，则可以将新设置导出到文件。您的同事可以按照导出方式导入此设置。

我希望这对你有所帮助。

使用Resharper实施编码指南

2 个答案: