Esta pregunta me ha estado obsesionando durante los últimos 2 meses.
Hace un tiempo, un amigo que es un gran programador me dio algunos códigos de ejemplo, y por primera vez noté un estilo único de organización de comentarios. Se esforzó por diseñar comentarios de una manera que me hiciera sentir más cómodo con el código en sí. Por ejemplo:
///////////////////////////////////////////// // //
// 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";
}
cuando podría simplemente haber escrito
/* This code prints a basic "Hello world" message to the console, change text in brackets */
#include <iostream>
int main() {
cout << "Hello world";
}
Este tipo de ejemplo solo a mayor escala. Esto me parece poco productivo en situaciones profesionales, pero en una situación de aprendizaje, parece ideal.
La pregunta aquí es si el estilo de comentario afecta cómo el lector entiende el código. En mi opinión personal, la opción n. ° 1 es más bonita a la vista y más fácil de seguir que la n. ° 2. ¿La forma en que comentas sobre el código afecta la capacidad de comprender tu código, o es solo una pérdida de tiempo y espacio?