Esta pergunta está me obcecando nos últimos 2 meses.
Há algum tempo, um amigo que é um grande programador me deu alguns exemplos de códigos e, pela primeira vez, notei um estilo único de organização de comentários. Ele se esforçou para criar comentários de uma maneira que me deixasse mais confortável com o próprio código. Por exemplo:
///////////////////////////////////////////// // //
// 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 ele poderia simplesmente escrever
/* 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 exemplo apenas em uma escala maior. Acho isso um pouco improdutivo em situações profissionais, mas em uma situação de aprendizado, parece ideal.
A questão aqui é, se o estilo do comentário afeta o modo como o leitor entende o código. Na minha opinião pessoal, a opção 1 é mais bonita aos olhos e mais fácil de seguir do que a 2. A maneira como você comenta o código afeta a capacidade de compreender seu código ou é apenas desperdício de tempo e espaço?