Cosa ha dimostrato la ricerca sull'efficacia dei commenti?

Naviga le tue risposte
6

Ho discusso con un amico sulla necessità di commenti e sull'efficienza dei diversi stili di commento. L'argomentazione si è conclusa abbastanza velocemente, in quanto non è stato possibile trovare alcuna ricerca - o saggio - a supporto di entrambe le affermazioni.

Sono state condotte serie ricerche sull'efficienza dei diversi stili di commento? Se sì, cosa ha mostrato? Sono principalmente interessato a:

  • Lunghezza (penso che i commenti più lunghi di un tweet non vengano mai letti)
  • Tipo (Sono strongmente favorevole ai commenti che sono esempi di codice effettivi, che spiegano come chiamare un metodo)
  • Posizione (come una linea separata? alla fine della linea?)
posta Adam Matan 23.02.2012 - 17:24
fonte

2 risposte

8

La risposta breve è sì , esistono studi pubblicati (su riviste e conferenze peer-reviewed) su vari aspetti dei commenti del programma.

Ecco alcuni esempi:

Prechelt, et al (2001) ha stabilito che "Linee di commento del modello" sono efficaci quando inserito in programmi in cui le attività di manutenzione sono state completate più velocemente con meno errori.

Nurvitadhi, Wing Wah Leung e Cook (2003) hanno determinato che i commenti di classe non sono utili per la comprensione ad alto livello, tuttavia i commenti sui metodi hanno aiutato con "comprensione del programma di basso livello".

A lettura interessante dall'Università di Montreal sui commenti nei programmi Java fornisce una buona sezione di lavoro correlato che discute alcune altre ricerche in quest'area.

Nessuno di questi studi suggerisce che tutti i commenti in tutte le situazioni siano buoni. Tuttavia forniscono alcune prove sperimentali solide che i commenti sono utili quando vengono eseguiti correttamente.

    
risposta data 23.02.2012 - 23:26
fonte
5

Potrebbero esserci delle ricerche, ma lo prenderei con un pizzico di sale. I buoni commenti sono difficili da definire e molto situazionali, è come chiedere una ricerca su come i buoni libri si basano sulla lunghezza delle parole o sul numero di pagine.

I buoni commenti sono una forma d'arte .

In una nota a margine ti suggerisco di leggere codice completo . È un'ottima guida su come scrivere buoni commenti.

    
risposta data 23.02.2012 - 17:46
fonte

Leggi altre domande sui tag

Soluzione tecnica Specialized VS Specialized; cosa prendere in considerazione? Perché mai vorremmo usare un metodo sincronizzato in Enum?