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

Probabilmente, la situazione di base è familiare a tutti. Hai concordato determinati standard di codifica nel tuo team e ora è il momento di assicurarti che tutti li seguano.

Alcuni lo fanno tramite una pesante programmazione abbinata, altri mantengono un elenco di standard di codifica e fanno una revisione manuale. Altri usano persino 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 sviluppatore dovrebbe conoscere? Come si integra la standardizzazione del codice negli strumenti di sviluppo?

StyleCop (ora anche StyleCop per Resharper) viene comunemente utilizzato per applicare regole di stile di codifica all'interno di basi di codice C #.

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

Innanzitutto, assicurati di disporre di un server di build adeguato che costruisca continuamente il tuo codice. TFS o Jenkins / Hudson + Msbuild sono buone opzioni. Ovviamente su questo server di build si eseguono test e si possono anche eseguire analisi di codice statico e controlli di sintassi.

Consiglio di usare FxCop o Gendarme per l'analisi del codice statico. Entrambi possono essere usati fianco a fianco.

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

Le regole empiriche sono:

• Avere sempre zero avvisi. Ridurre inizialmente il set di controlli, se necessario, quindi aggiungere alcuni nuovi controlli ogni sprint e correggerli. Assicurati che ogni controllo eseguito abbia un valore reale per te e sia 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, utilizzare StyleCop o StyleCop per Resharper se si utilizza Resharper (che consiglio anche vivamente).

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.

Consiglio FxCop per la 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.

Le metriche del codice sono talvolta influenzate dagli stili di codice. È possibile monitorare la manutenibilità dei codici con questo strumento.

Vorrei sottolineare come far funzionare prima l'analisi del codice automatica già menzionata (FxCop, StyleCopy, build CI, ecc.), Preferendo le revisioni manuali. I controlli automatici rileveranno molte più cose di quanto non sia probabile una revisione manuale, ed è normalmente molto più rigoroso, coerente e auto-documentante. Le revisioni manuali possono essere utili per decisioni di progettazione di alto livello, ecc., Ma nella mia esperienza possono essere molto soggettive e casuali.

NDepend può essere utilizzato per applicare vari standard di codifica su una base di codice .NET. Ha circa 200 regole di codice predefinite che possono essere sfogliate qui . Inoltre è facile personalizzare le regole esistenti o creare le proprie regole poiché con NDepend una regola è solo una query C # LINQ .

Disclaimer: lavoro per NDepend