Das Hinzufügen eines Kommentarblocks am Anfang einer Methode ist nützlich, um einen Hinweis auf die Funktion der Methode sowie eine Liste der Eingabe-/Ausgabeparameter hinzuzufügen. Und ein paar Zeilen mit lesbarem Text innerhalb eines komplizierten Codeabschnitts können Ihnen und anderen helfen, sich an den Zweck dieses bestimmten Codeabschnitts zu erinnern. Ab 4D v18 wird Ihre Programmiererfahrung durch die Hinzufügung von Kommentarblöcken verbessert!
Kommentare sind Texte (Notizen, Beschreibungen, Erinnerungen usw.) im Quellcode, die mit speziellen Zeichen gekennzeichnet sind, damit sie vom Compiler während der Codeausführung ignoriert werden. Kommentare können in einer einzigen Zeile stehen oder sich über mehrere Zeilen erstrecken. Anstatt viele Zeilen mit // zu versehen, können Sie jetzt einfach /* am Anfang eines Kommentars und */ am Ende verwenden, um einen ganzen Block zu kommentieren. Sie können sie auch ein- und ausklappen! Und das ist noch nicht alles: Sie können Kommentare auch an jeder beliebigen Stelle einer Zeile einfügen, sogar innerhalb einer if Bedingung oder einer Schleife:
Warum Kommentare wichtig sind
- In einem Team mit mehreren Entwicklern, die an demselben Projekt arbeiten, ist gut kommentierter Code für die anderen hilfreich, damit sie den Code besser verstehen und den Prozess der Codeüberprüfung/des Debugging erleichtern können.
- Wir sind auch nur Menschen und es ist völlig normal, dass wir Dinge vergessen. Wenn Sie Ihren Code später ansehen oder bearbeiten, können Kommentare Ihnen helfen, sich an die Logik zu erinnern, die Sie beim Schreiben des Codes verwendet haben. Selbst wenn Sie einen wirklich einfachen Code schreiben, versuchen Sie ihn Monate oder Jahre später zu lesen. Wird er Ihnen immer noch einfach erscheinen, oder würden Sie sich wünschen, Sie hätten Kommentare hinzugefügt?