Come garantire un singolo standard di codifica in .NET con il supporto degli strumenti

Question

Come garantire un singolo standard di codifica in .NET con il supporto degli strumenti

#1 da (12 voti)
#2 da (5 voti)
#3 da (2 voti)
#4 da (1 voti)

12

Probabilmente, la situazione di base è familiare a tutti. Hai concordato alcuni standard di codifica nella tua squadra e ora è il momento di assicurarti che tutti li seguano.

Alcuni lo fanno tramite una programmazione abbinata, altri mantengono un elenco di standard di codifica e eseguono una revisione manuale. Altri ancora utilizzano lo strumento di analisi del codice statico di Visual Studio per assicurarsi che vengano applicati gli standard di codifica.

Quali sono le tue migliori pratiche per garantire gli standard di codifica? Quali strumenti usi? Ci sono alcuni strumenti essenziali che ogni dev dovrebbe sapere? Come integri la standardizzazione del tuo codice nei tuoi strumenti di sviluppo?

Grazie!

Stefan

coding-style c# .net

posta Stefan Papp 02.03.2012 - 16:52

fonte

4 risposte

Leggi altre domande sui tag coding-style c# .net

Un buon schema per rappresentare numeri interi da 0 a infinito, assumendo che tu abbia una memoria binaria lineare infinita? Soffro di abuso di incapsulamento?

score 12 · Answer 1

StyleCop (ora anche StyleCop per Resharper) è comunemente usato per rafforzare le regole di stile di codifica all'interno delle basi di codice C #.

Può essere integrato nella build del CI e causare errori di compilazione se sono state introdotte delle violazioni.

score 5 · Answer 2

Per prima cosa, assicurati di avere un server di build appropriato che sviluppi continuamente il tuo codice. TFS o Jenkins / Hudson + Msbuild sono buone opzioni. Su questo server di build, naturalmente, esegui test e puoi anche eseguire analisi del codice statico e controlli di sintassi.

Ti consiglio di utilizzare FxCop o Gendarme per l'analisi del codice statico. Entrambi possono essere utilizzati fianco a fianco.

Una chiave importante per il successo: non distribuirli con un set di regole massiccio e aspettarsi che funzioni bene. Avrai milioni di avvertimenti e nessuno se ne preoccuperà.

Le regole di base sono:

Avere sempre zero avvisi. Riduci il set di assegni inizialmente se necessario, quindi aggiungi alcuni nuovi assegni ogni sprint e correggi quelli. Assicurati che ogni controllo eseguito abbia un valore reale per te ed è coerente con i tuoi standard.
Se hai regole specifiche per il dominio a cui devi aderire, non aver paura di implementare le tue regole.

Per il controllo della sintassi, usa StyleCop o StyleCop per Resharper se usi Resharper (che consiglio vivamente).

score 2 · Answer 3

StyleCop e FxCop sono i miei strumenti leggeri che ricordano gli stili di codice ai miei sviluppatori . Anche Resharper è buono, ma rende VS molto lento.

Raccomando FxCop a causa della sua "ricca libreria di regole, con ottima documentazione, classificazioni, esempi e molte altre funzionalità.

C'è anche l'estensione StyleCop Fixer per visual studio disponibile, aiuta a correggere gli errori ordinari.

Anche le metriche del codice sono influenzate a volte dagli stili di codice. È possibile monitorare la manutenibilità dei codici con questo strumento.

score 1 · Answer 4

Vorrei enfatizzare il funzionamento dell'analisi del codice automatica già menzionata (FxCop, StyleCopy, build CI, ecc.), in primo luogo rispetto alle revisioni manuali. I controlli automatici raccolgono molte più cose di quanto sia probabile una revisione manuale, e sono normalmente molto più rigorosi, coerenti e autodocumentanti. Le revisioni manuali possono essere utili per decisioni di progettazione di alto livello, ecc., Ma nella mia esperienza possono essere molto soggettive e disordinate.