Kommentare in Java und IntelliJ
Java Tutorial zu Kommentaren. Was sie sind, wie du sie einfügst und ein praktischer Shortcut in IntelliJ für Kommentare über mehrere Zeilen.Tags: Algorithmus | Debuggen | Formatierung | Java | Kommentare | Programmieren lernen | StrukturWorum geht´s?
In diesem Tutorial lernst du, was Kommentare in Java sind, wofür sie gut sind, wie du sie einsetzt und noch einen nützlichen IntelliJ Shortcut, um mehrere Zeilen auf einmal zu kommentieren.
Was sind Kommentare in Java?
Kommentare in Java sind – wie in jeder Programmiersprache – Teile deines Source-Codes, der vom Programm ignoriert wird.
Er dient also zur besseren Übersicht des Source-Codes, bzw. teilweise auch zum einfachereren Debuggen.
Wofür werden Kommentare in Java verwendet?
Du kannst Kommentare einsetzen, um für dich oder andere TeamkollegInnen Notizen im Code einzufügen. So kannst du zum Beispiel erklären, was du dir beim Schreiben eines bestimmten Algorithmus gedacht hast.
Außerdem kannst du Kommentare verwenden, um deinen Source-Code zu gliedern, ähnlich als würdest du „Kapitel“ in deinen Source-Code einfügen.
Und schlussendlich sind Kommentare auch praktisch beim Debuggen, also bei der Fehler-Suche. Sie können verwendet werden, um bestimmte Code-Teile aus dem Programm auszuklammern, um rascher die restlichen Teile testen zu können.
Stell dir z.B. vor, du programmierst einen Algorithmus, der überprüfen soll, ob eine zufällige Zahl bestimmte Voraussetzungen erfüllt. Dein Algorithmus funktioniert fast immer, nur in ganz wenigen Fällen ist noch ein kleiner Fehler versteckt.
Anstatt jetzt das Programm unzählige Male zu starten und darauf zu hoffen dass die zufällige Zahl vielleicht eine ist, wo der Fehler erscheint, kannst du auch einfach den Code-Teil, der für die zufällige Zahl zuständig ist, zu einem Kommentar machen, und die Zahl „händisch“ setzen.
So kannst du viel rascher austesten, ob deine Verbesserungen erfolgreich waren.
Wie du in Java Kommentare einfügst
Grundsätzlich gibt es in Java 2 verbreitete Methoden, einen Teil deines Source-Codes zum Kommentar zu machen:
- // macht die ganze Zeile rechts davon zum Kommentar
- /* Schrägstrich+Stern macht alles bis zum nächsten Stern+Schrägstrich zum Kommentar */
public class HelloWorld { public static void main(String[] args) { int a2 = 3; //System.out.println(a2); System.out.println("YEHAA!"); /*a2 = 6; a2 = 4; System.out.println(a2);*/ a2 = 2; System.out.println(a2); // System.out.println("asdf"); // System.out.println("asdfd"); } }
In IntelliJ gibt es noch zusätzlich die Möglichkeit, mit Hilfe von STRG + / (Nummernblock!) einen markierten Source-Code mit //-Strichen zu Zeilen-Beginn zu versehen bzw. die //-Striche wieder zu entfernen:
Wichtig bei Kommentaren ist immer: So viel wie notwendig, aber nicht mehr. Dein Programm soll kein Buch werden 😉