Ho lavorato a un progetto per circa un mese. Sono estremamente familiare con il codice e lo capisco nella misura in cui ritengo che sia così facile da capire, che la maggior parte dei metodi non ha bisogno di commenti a mio parere. Non posso dire se è perché è in realtà un codice semplice o che sono solo molto pratico su come funziona. Come si traccia la linea tra codice semplice e codice che richiede commenti?
Se il codice è semplice dovrebbe essere facile da comnentare. Fallo e basta, in frasi grammaticalmente corrette, usando una nomenclatura coerente snd appropriata.
In alcune occasioni potresti trovare difficile scrivere una buona intestazione di documentazione o troverai un metodo che fa più del dovuto.
Prendere la documentazione seriamente porta a un codice migliore. Rafforza il tuo design obbligandoti ad esprimere la tua logica in una lingua diversa. Se il design ha ancora senso quando hai finito dovresti essere bravo. Se inizia a sentirti sbagliato o hai difficoltà a trovare una descrizione chiara, hai ancora del lavoro da fare.
E, ultimo ma non meno importante, renderà il tuo codice più accessibile, se non a qualcun altro, dopo aver dimenticato cosa ha fatto.
Se scrivi in C # .NET, controlla StyleCop. Mi piace. Ma dovrebbe esserci qualcosa di simile per qualsiasi lingua.
Sono nella stessa situazione. Dopo aver lavorato sul codice per un po ', ne sei diventato estremamente familiare. Sai come funziona. Ma immagina se dovessi leggere qualcosa che qualcun altro ha scritto per la prima volta. I commenti renderebbero quel codice molto più facile da leggere. Quello che generalmente mi piace fare (e ho un'esperienza molto limitata) è di fare un commento di alto livello per algoritmi e funzioni che spieghi cosa stanno facendo in generale. E poi se c'è una linea di codice che fa qualcosa di più complesso, come una sorta di calcolo o qualcosa del genere, quindi includi un commento che spiega cosa sta succedendo. Spero che questo aiuti.
Semplice. commenta sempre e metti un controllo automatico che impedisce che il codice non contenga commenti.
I programmatori avanzati potrebbero iniziare a saltare commenti uguali a quelli di una funzione o di una variabile.
Leggi altre domande sui tag code-quality readability comments