2012-01-10 1 views
9

Sto cercando di trovare un elenco di tutte le formattazioni e regole predefinite applicate da Resharper.Elenco di formattazione e regole predefinite di Resharper

Purtroppo, non sto avendo fortuna.

Utilizziamo lo strumento, ma vogliamo fornire un documento di standard ai nuovi assunti in modo che possano visualizzare gli standard prima della codifica.

+2

imho questo è necessario. Solo perché è noioso non significa che sia ingiustificato.Va bene dire che non è perché si può semplicemente guardare attraverso le impostazioni delle regole, tuttavia la maggior parte dei negozi di grandi dimensioni richiede la documentazione e la discussione di "cosa è l'impostazione predefinita" e "questa regola è appropriata per lo SDLC come definito dalla mia organizzazione" –

risposta

7

Sotto il menu ReSharper, quindi Opzioni, troverai le regole e le convenzioni correnti utilizzate da ReSharper per questa soluzione. Di particolare importanza sono:

Codice Ispezione-> Ispezione Gravità: Mostra la gravità delle cose rilevate da ReSharper nel codice. Più cose sono avvertimenti o errori, più strettamente dovrai conformare il codice alle convenzioni di ReSharper per far sì che il file diventi "verde", o anche per compilare. La gerarchia è:

  • Do Not Show - auto-esplicativo, ignora l'ispezione
  • Suggerimento - Non mostra sulla barra laterale, mostra come la linea tratteggiata sotto il codice in questione. Un buon esempio: usare "var" quando la linea di codice non specifica esplicitamente il tipo che viene assegnato.
  • Suggerimento: visualizzato sulla barra laterale come segno di spunta verde, il codice in questione ha una sottolineatura verde. Buoni esempi: uso di "var" quando type è definito esplicitamente nell'assegnazione, visibilità dei membri.
  • Avviso: mostra sulla barra laterale come segno di spunta giallo, il codice in questione è sottolineato in blu o il testo è di colore sfumato. Denominazione delle violazioni delle convenzioni, parole chiave ridondanti o qualificatori, membri di codice non utilizzati.
  • Errore - Segno di spunta sulla barra laterale rossa, codice in questione o testo rosso o sottolineato rosso. Per impostazione predefinita, nulla che non causi un errore di compilazione viene contrassegnato come errore ReSharper, ma è possibile impedire la compilazione "promuovendo" le ispezioni con priorità inferiore agli errori.

Lingue-> Naming Stile: Questa sezione mostra come ReSharper si aspetta vari tipi di nomi dei membri del codice da formattare. L'opzione "Impostazioni avanzate" contiene anche la "lista delle abbreviazioni", che è fondamentalmente un elenco di eccezioni alle normali convenzioni del telaio del cammello. Per impostazione predefinita, tutte le incoerenze di formato sono avvisi e non vedo un modo in 5.1 (la versione che uso) per modificare la gravità di questo.

MODIFICA: ecco un elenco di ispezioni e le loro severità predefinite per RS ​​4.5, che è un po 'di versioni precedenti ma dovrebbe comunque avere la "carne" delle ispezioni C# di ReSharper. http://unintelligible.org/blog/2010/05/24/resharper-45-inspection-severity-list/

Oltre a ciò, anche JetBrains fa semplicemente riferimento alla finestra Opzioni se si desidera visualizzare l'elenco delle ispezioni per la lingua corrente. Quindi, se vuoi qualcosa di più aggiornato, potresti doverlo fare da solo. Se lo fai, assicurati di postarlo da qualche parte in modo che gli altri non debbano ripetere il tuo lavoro.

+0

Ma c'è una lista da qualche parte di ciò che sono tutti i valori predefiniti? Piuttosto che copiare tutte le informazioni in un documento dalle impostazioni? – CaffGeek

+0

Sto guardando. Se c'è una posizione che elenca tutti i valori predefiniti, mi aspetterei che si trovi sul sito JetBrains, ma la documentazione non sembra avere nulla di esplicito. – KeithS

+0

è quello che ho trovato anch'io – CaffGeek

1

Lo standard di codifica aziendale IMHO è più che una semplice formattazione. Solitamente include convenzioni di organizzazione del progetto, linee guida sull'utilizzo della biblioteca, ecc. Elencare tutte le possibili regole di formattazione che ReSharper conosce renderà piuttosto lungo e noioso. Alcuni esempi di costrutti comuni (che è possibile copiare dalla parte inferiore della finestra di impostazione della formattazione) dovrebbero essere sufficienti. Fornire loro una motivazione razionale non dovrebbe essere troppo difficile da fare manualmente.

+0

Sono d'accordo, ma non è la mia chiamata. – CaffGeek