2017-01-09 2 views
1

In meinem Projekt gibt es einige Codierungsstandards, die wir für Web API befolgen müssen. Gibt es eine Möglichkeit, diese Anweisungen in Resharper zu konfigurieren? Ich benutze Resharper Ultimate Edition. Außerdem können wir Resharper so konfigurieren, dass, wenn diese Anweisung nicht befolgt wird, ein Fehler ausgegeben wird und Vorschläge angezeigt werden.Implementieren von Codierungsrichtlinien mit Resharper

Die Leitlinien enthalten allgemeine Anweisung wie:

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 
+0

Vielen Dank für die schnelle Antwort. Aber ich brauche mehr Anpassung. z.B. Wenn jemand Endpunkte als Hauptbuchstabe definiert [Route ("Verkäufer/Suche/{Seite}/{PageSize}")] dann sollte er einen Fehler werfen und iplement als [Route ("Verkäufer/Suche/{Seite}/{" vorschlagen pageSize} ")] – SKiran

Antwort

0

Wenn Sie das Optionsmenü von ReSharper in Visual-Studio öffnen Sie solche Dinge konfigurieren können. Wenn Sie bis zum Ende Ihrer Optionsliste blättern, können Sie für jede Sprache, die unterstützt wird, verschiedene Knoten finden. Dort können Sie beispielsweise Großbuchstaben, Kleinbuchstaben oder das Klammerlayout konfigurieren. Der Screenshot zeigt einige Konventionen für C#. enter image description here

Ich kenne keine Möglichkeit, die Fehlermeldungen für das ermöglicht. Aber es gibt eine Verknüpfung, die Ihre konfigurierten Stile für eine ganze Datei verwendet (Strg + E + F in meinem Fall). Wenn also jemand Ihre Konventionen nicht benutzt und Sie eine Klasse von ihm öffnen, drücken Sie einfach die Kombination und das Dokument wird gestylt. Vielleicht kann dies auch über Jenkins oder etw. In Build-Prozesse integriert werden. Aber ich habe das noch nicht ausprobiert.

Wenn Sie zu Resharper-> Manage Options gehen, können Sie Ihre neuen Einstellungen in Datei exportieren. Ihre Kollegen können diese Einstellungen genauso importieren, wie Sie sie exportieren.

Ich hoffe, das ist hilfreich für Sie.

+0

Danke für die Hilfe. – SKiran

1

Ich glaube, dass Sie nach StyleCop suchen, zusammen mit seinem Resharper-Plugin. StyleCop "analysiert C# Quellcode, um eine Reihe von Stil- und Konsistenzregeln zu erzwingen", einschließlich Regeln, die Sie selbst schreiben können.

https://github.com/StyleCop

+0

Danke für Hilfe. Dies kann durch das Schreiben einer benutzerdefinierten Regel mit StyleCop https://github.com/Visual-Stylecop/Visual-StyleCop/wiki/Authoring-a-Custom-StyleCop-Rule erreicht werden – SKiran