Beim Programmieren auf einem Computer ist es manchmal notwendig, Notizen oder Kommentare zu hinterlassen, damit andere Entwickler Ihren Code problemlos durchsuchen können. Ob Open-Source-Projekt oder proprietäres Projekt, Kommentare werden benötigt, um sich mit Co-Entwicklern und möglichen zukünftigen Entwicklern abzustimmen. Ohne Kommentare wäre Code einfach nicht wartbar.
Schritte
Schritt 1. Verstehen Sie den Zweck des Kommentierens eines Computerprogramms
- Die Lesbarkeit steht hier im Vordergrund. Wenn Sie sich einen Kommentar ansehen, sollten Sie wissen, dass es sich um einen Kommentar und nicht um eine Codezeile handelt.
- Der Kommentar sollte nicht nur für Sie hilfreich sein, sondern auch für jeden anderen, der den Quellcode Ihres Computerprogramms lesen könnte.
Schritt 2. Überlegen Sie sich einen kurzen, einfachen Weg, um Ihren Standpunkt zu vermitteln
Kommentare müssen kein Kunstwerk sein. Sie sollten prägnant, übersichtlich und direkt auf den Punkt gebracht werden.
Dies sollte jedoch nicht davon abhalten, mehrere Zeilen für einen Kommentar zu verwenden. Der Punkt ist, dass die Informationen beim Leser ankommen müssen
Schritt 3. Schreiben Sie den Kommentar mit der entsprechenden Syntax der Programmiersprache
Schritt 4. Fragen Sie sich, ob der Kommentar, den Sie geschrieben haben, detailliert genug ist
Ein Kommentar sollte jemandem, der sich den Quellcode ansieht, sagen können, was dieser Teil des Programms tatsächlich tut, ohne ihn kompilieren und ausführen zu müssen. Erreicht Ihr Kommentar dies? Vermittelt es alle Details?
