8
Sto cercando una risposta piuttosto arbitraria, quindi potrebbe essere più una discussione. Mi chiedo quale sia la migliore pratica per commentare il mio codice C# in Visual Studio. In questo momento sto usando il triplo /// per generare l'xml e usare sand castle per creare un file chm o html. Ma il mio problema è che io uso i commenti del codice per due motivi:commenting code C# visual studio best practice
- Quando gli altri sviluppatori stanno utilizzando il mio codice si può leggere la documentazione, sia Intellisence ed il chm. o file html.
- Ma io uso anche commenti come promemoria per me stesso. Quindi ricordo i miei pensieri quando tornerò dopo un anno e mezzo, con metodi complessi.
In che modo entrambi gli obiettivi possono essere raggiunti senza interferire tra loro e allo stesso tempo essere un compito rapido, senza impiegare molto tempo per la codifica?
Grazie per la risposta. Penso che tutti abbiamo il problema del duello che ci viene pagato per il nostro lavoro, quindi dobbiamo creare un buon codice e non usare troppe ore per scriverlo. A volte i commenti possono essere usati come una soluzione rapida e sporca per questo. E so che non è la miglior pratica :) – DNRN
Sono d'accordo con te. C'è sempre un compromesso tra buona qualità ed economia. Scrivo certamente commenti come "// TODO: non dimenticarti di refactoring" o "// HACK: fix later" personalmente :-) Ovviamente dipende dal tipo di progetto, ma spesso mi trovo a scrivere codice che ha essere mantenuto per molti anni (spesso da altre persone rispetto a me) e in tal caso paga davvero a lungo termine quando mi prendo molta cura di scriverlo. Quando scrivo un prototipo, prendo molto meno attenzione. – Steven
@DNRN: parlando di economia, hai sentito parlare del concetto di "debito tecnico"?L'idea è che se rimanderai il refactoring per una data successiva, stai acquisendo un debito tecnico che dovrà essere ripagato in futuro, con interesse. L'interesse in questo caso è il sovraccarico di ricordare cosa fa il codice. Invece, raccomando uno strumento di refactoring di qualità, come ReSharper o CodeRush che rende il lavoro di refactoring estremamente efficiente. Usando uno strumento come questo, ottieni il meglio da entrambi i mondi ... refactor ora senza i tempi supplementari. –