Questa domanda mi ha ossessionato negli ultimi 2 mesi.
Qualche tempo fa un amico che è un grande programmatore mi ha dato alcuni codici di esempio, e per la prima volta ho notato uno stile unico di organizzazione dei commenti. Si è sforzato di progettare i commenti in un modo che mi rendesse più comodo con il codice stesso. Ad esempio:
///////////////////////////////////////////// // //
// This code prints a basic "Hello world" //
// message to the console screen. You can //
// change the text in the brackets. //
// //
/////////////////////////////////////////////
#include <iostream>
int main() {
cout << "Hello world";
}
quando avrebbe potuto semplicemente scrivere
/* This code prints a basic "Hello world" message to the console, change text in brackets */
#include <iostream>
int main() {
cout << "Hello world";
}
Questo tipo di esempio solo su una scala più grande. Trovo che questo sia un po 'improduttivo nelle situazioni professionali, ma in una situazione di apprendimento, sembra l'ideale.
La domanda qui è, se lo stile di commento influisce su come il lettore capisce il codice. Nella mia opinione personale, l'opzione n. 1 è più carina alla vista e più facile da seguire della # 2. Il modo in cui commentate il codice influisce sulla capacità di comprendere il vostro codice o è solo uno spreco di tempo e spazio?