2010-05-07 19 views
19

Non sono riuscito a trovare alcuna domanda direttamente applicabile alla mia query, quindi la sto postando come una nuova domanda. Se c'è qualche discussione esistente che potrebbe aiutarmi, ti preghiamo di segnalarlo e chiudere la domanda.Linee guida per la codifica + Best practice?

Domanda:

ho intenzione di fare una presentazione sugli orientamenti C# codifica ma non dovrebbe limitarsi a standard di codifica.

Quindi ho un'idea approssimativa, ma penso di dover affrontare buone pratiche di programmazione. Quindi il contenuto sarà qualcosa come questo.

  1. standard di codifica di base - Involucro, formattazione ecc

  2. Buone pratiche - Utilizzo di HashSet sulle altre strutture di dati, String vs String Builder, immutabilità di stringa e li utilizzano in modo efficace ecc

In realtà vorrei aggiungere altre buone pratiche (Soprattutto per migliorare le prestazioni). Mi piace quindi ascoltare alcune buone pratiche da utilizzare con C#. Eventuali suggerimenti??? (Non c'è bisogno di grandi descrizioni :) Solo l'idea è sufficiente.)

+3

Probabilmente questo dovrebbe essere wiki della comunità. –

+1

Fare attenzione alla creazione di standard di codifica proprietari. Gli standard di codifica sono spesso ben intenzionati ma spesso fanno infuriare gli sviluppatori quando sono contrari a quanto pubblicato da Microsoft. Creare un documento con un collegamento a MSDN;) – Jonathan

+0

Un articolo ben scritto con le ultime linee guida e suggerimenti https://www.codingular.com/2017/05/csharp-coding-style-guidelines-best-practices/ –

risposta

1
  • Standard di codifica di base: assicurarsi che sia coerente. Anche se non seguono le convenzioni stabilite in this document on msdn. Penso che la coerenza sia davvero la chiave qui.

  • Test unità - Non si può sbagliare qui.

  • Sicurezza: parlare di garantire che se si trasmettono dati sensibili in giro è sicuro.

  • Prestazioni - Sapete, personalmente ritengo che ottenere l'applicazione giusta e guardare le prestazioni è ciò che faccio. Ce l'ho nella parte posteriore della mia mente quando scrivo il codice, quindi alla fine si tratta di piccoli aggiustamenti.

8

Ecco alcuni consigli:

  1. Usa FxCop per l'analisi statica.
  2. Utilizzare StyleCop per la convalida dello stile di codifica.
  3. A causa dei diversi semantica dei tipi di valore, fornire loro un colore alternativo nell'IDE (andare a Strumenti/Opzioni/Ambiente/Caratteri e colori/visualizzare gli elementi e fornire tipi di utente (enumerazioni) e utente Tipi (tipi di valore) con un valore come # DF7120 [223, 113, 32]).
  4. Poiché le eccezioni tendono a mostrare bug nel codice, lasciare che l'IDE si interrompa su tutte le eccezioni. (vai a Debug/Eccezioni .../Common Language Runtime Exceptions e check Throw).
  5. Impostazioni progetto: non consentire codice non sicuro.
  6. Impostazioni del progetto: avvisi di minaccia come errori.
  7. Impostazioni del progetto: verifica di overflow/underflow aritmetico.
  8. Utilizzare le variabili per un singolo obiettivo ben definito.
  9. Non utilizzare numeri magici.
  10. Scrittura di metodi brevi. Un metodo dovrebbe contenere solo un livello di astrazione.
  11. Un metodo non può mai essere troppo piccolo (un metodo di 20 righe è considerato piuttosto grande).
  12. Un metodo deve proteggersi da input errati.
  13. Considera di rendere un tipo immutabile.
  14. Non sopprimere gli avvisi nel codice con la disattivazione di pragma.
  15. Non commentare codice errato: riscrivilo.
  16. Documento esplicitamente nel codice perché si sta ingoiando un'eccezione.
  17. Notare le implicazioni di prestazione della concatenazione delle stringhe.
  18. Non utilizzare mai istruzioni goto.
  19. Errore in anticipo, errore veloce.
Problemi correlati