Computer, Informatik, Internet und Programmieren
30 Mrz
Als Kommentare bezeichnet man in Programmiersprachen besondere Code-Teile, die vom Compiler nicht in Maschinencode – in Java Bytecode – übersetzt werden, sondern nur den Lesern beziehungsweise den Programmierern dienen.
Neben selbst sprechenden Namen für Variablen, Klassen und Methoden, sollte man Kommentare verwenden, um bestimmte Stücke des Quellcodes zu dokumentieren. Damit erleichtert man zum Einen anderen Entwicklern zu verstehen was ein Codefragment macht und zum anderen ist man dadurch in der Lage auch ein Programm zu verstehen, das man zum letzten mal vor einigen Monaten angesehen hat.
Auch benutzt man Kommentare, um Anmerkungen – wie TODOs – festzuhalten, die einem während dem Programmieren auffallen.
Java bietet uns drei Möglichkeiten von Kommentaren:
Ein Zeilenkommentar gilt nur für eine Zeile und wird mit einem // eingeleitet. Möchte man Kommentare über mehrere Zeilen hinweg setzten, so bietet sich das Blockkommentar dafür an. Dieses wird mit einem /* eingeleitet und endet mit */.
Das JavaDoc-Kommentar ist ein besonderes Blockkommentar, das zum Beispiel Beschreibungen von Funktionen und / oder deren Parameter enthält. Beginnt man ein Kommentar mit /** und schließt es mit */ ab, handelt es sich um diesen Typ von Kommentar. Mit dem im JDK mitgelieferten Tool javadoc ist es möglich diese Kommentare zu einer API-Dokumentation zu generieren.
Mit Kommentaren können wir Code auch zum Testen und zur Fehlersuche auskommentieren, um diese vor dem Compiler zu verstecken.
Dieses Beispiel soll uns die Verwendung von Kommentaren in Java verdeutlichen:
/** * @author eugen * @version 1.0 */ class RasenMaehen { /* * Dieses Programm berechnet, ob man seinen Rasen mähen sollte */ public static void main ( String[] args ) { //Maße in cm int aktuelleLaenge = 53; int gewuenschteLaenge = 20; int maxUeberschuss = 10; // Wenn Ueberschuss zu groß, muss gemaeht werden if( (aktuelleLaenge – gewuenschteLaenge) > maxUeberschuss ) { System.out.println("Rasen muss gemaeht werden"); } else { System.out.println("Geht noch!"); } } }
Bei dem ersten Kommentar handelt es sich um einen JavaDoc-Kommentar, der besondere Schlüsselwörter wie @author enthält, die vom javadoc-Tool ausgewertet werden können.
Der zweite Kommentar auf den wir stoßen ist ein Blockkommentar, der sich über drei Zeilen hinzieht.
Bei dem dritten und vierten Kommentar verwenden wir nun den Zeilenkommentar, der wie gesagt nur eine Zeile auskommentiert.