Programmierstandard Kommentar

Ein Kommentar in der Computersprache ist eine Notation, die man im Quelltext verwendet, um einen Hinweis an den Textbearbeiter zu geben. Wird nach der Erstellung eines Programms der Quelltext kompiliert, interpretiert, geparst oder ähnliches, werden diese Kommentare von der verarbeitenden Software ignoriert und haben so keinen Einfluss auf das Ergebnis selbst, sondern dienen nur als Hilfestellung für den Programmierer, der gerade daran arbeitet.

Mögen die Kommentare für einen vielleicht unnütz oder abwertend erscheinen, so merkt man doch spätestens dann, wenn ein Programmierer das Programm eines anderen Programmierers übernimmt, wie wichtig und hilfreich sie sind. Sie sind oftmals ohne Kommentare eher wie eine kryptische Schrift. Es hilft, ein Programm zu erlesen und auch die Blöcke zu überspringen, die man selber gar nicht braucht.

Aus dem Grunde haben auch viele Programmierstile einen extra Teil, der eben genau diese Kommentierung erklärt, was und wie kommentiert werden soll. In Universitäten werde ganze Vorlesungen diesem Argument gewidmet. Nichts schlimmer ist jedoch, wenn es zu viele Kommentare gibt, die eher verwirren als helfen. Jeder, der die Software eines anderen warten muss, kann sowas bestätigen.

Es gibt Blockkommentare und Zeilenkommentare. Dabei können diese Kommentare einen Zeilenumbruch haben, doch gibt es einige, die dann neu geöffnet werden müssen, also ohne auskommen und die gesamte Zeile lang sind.

Kommentare kann man natürlich frei verwenden, doch sie werden am häufigsten zur Erklärung des Quelltextes genutzt. Ebenfalls zur Gliederung, zur Erläuterung einer einzelnen Zeile, einem eventuellen Hinweis einer erledigten Arbeit sowie zur Auskommentierung. Wobei bei der letzten Kommentierung ein Codestück in einen Kommentar gesetzt wird und somit für den Compiler nicht mehr sichtbar ist. Das macht man beispielsweise, wenn man einen Code vorübergehend entfernen, später aber wahrscheinlich wieder einsetzen will. Damit wird er nicht gelöscht und man müsste ihn neu schreiben, sondern lediglich für den entsprechenden Zeitraum unsichtbar gemacht.

In diesen Kommentaren sollte stehen, wozu diese Variable oder der Block genutzt werden soll, wie er richtig genutzt wird und alle wichtigen Details. Auch Hauptfunktionen sollten eventuell kommentiert werden. Eine Hauptfunktion sollte einen Header beinhalten und in ihm sollte stehen, wie der Block funktioniert, der Kontrakt und was gebraucht wird.

Auf jeden Fall sollte auch jede Sektion eines Nicht-Standard-Codes kommentiert werden. Somit wird sein Gebrauch erklärt, Erneuerungen eingebracht, auf unausgefeilte Teile aufmerksam gemacht und ähnliches. Die Kommentare werden entweder in der Muttersprache des Programmierers oder aber einer universellen Sprache wie Englisch geschrieben.