Diese Frage beschäftigt mich seit 2 Monaten.
Vor einiger Zeit gab mir ein Freund, der ein großartiger Programmierer ist, einige Beispielcodes, und zum ersten Mal bemerkte ich einen einzigartigen Stil beim Organisieren von Kommentaren. Er bemühte sich, Kommentare so zu gestalten, dass ich mich mit dem Code selbst besser auskenne. Zum Beispiel:
///////////////////////////////////////////// // //
// 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";
}
wenn er einfach hätte schreiben können
/* This code prints a basic "Hello world" message to the console, change text in brackets */
#include <iostream>
int main() {
cout << "Hello world";
}
Diese Art von Beispiel nur in größerem Maßstab. Ich finde das in beruflichen Situationen etwas unproduktiv, aber in einer Lernsituation scheint es ideal.
Die Frage ist hier, ob der Kommentarstil das Verständnis des Lesers für Code beeinflusst. Meiner persönlichen Meinung nach ist Option 1 für das Auge hübscher und leichter zu befolgen als Nummer 2. Beeinflusst die Art und Weise, wie Sie Code kommentieren, die Fähigkeit, Ihren Code zu verstehen, oder wird nur Zeit und Platz verschwendet?