Kommentieren in XML und Java: Cheatsheet für Android-Programmierer
Weil es besser ist, die Syntax für Kommentare ab und zu nachzusehen als gar keine Kommentare zu schreiben: Dieser Post beinhaltet Erläuterungen zum Kommentieren in XML- und Java-Dateien sowie ein knappes Cheatsheet für Android-Programmierer. Damit steht lesbarem Code nichts mehr im Weg! 😉
Kommentieren in XML-Dateien
In allen XML-Dateien kann folgendermaßen kommentiert (und auskommentiert) werden:
<!-- Zeilenkommentar --> <!-- Blockkommentar über mehrere Zeilen -->
XML kennt keine Syntax-Unterschiede bei Zeilen- und Blockkommentaren.
Es ist nicht möglich, innerhalb eines Tags oder einer Deklaration zu kommentieren. Wenn z.B. Eigenschaften eines Objekts auskommentiert werden sollen, müssen diese sich dafür außerhalb des Tags befinden.
Blockkommentar in XML-Datei: Auskommentiertes TextView
Zeilenkommentar in XML: Eigenschaft eines TextViews auskommentiert
Kommentieren in Java-Dateien
In Java gibt es Syntax-Unterschiede bei Zeilen- und Blockkommentaren. Beide können zum Kommentieren und Auskommentieren genutzt werden.
Zeilenkommentare gelten immer bis zum Ende der jeweiligen Zeile und werden folgendermaßen erstellt:
// Eine ganze Zeile auskommentieren
door.open(); // Kommentar am Zeilenende
door.open(); // Nicht schoen, aber moeglich: \
mit Backslash in naechster Zeile fortsetzen
Einfacher Zeilenkommentar in Java
Kommentar am Zeilenende in Java
Blockkommentare können mehrzeilig sein, aber auch nur für eine Zeile oder sogar mitten im Code verwendet werden:
/* Mehrzeiliger
Blockkommentar */
/* door.isOpen(); */
if (door.isOpen() /* + door.isUnlocked() */ ) {...};
Blockkommentar in Java: Mehrzeiliger Block auskommentiert
In den Java-Dateien kann außerdem Javadoc verwendet werden:
/** * Javadoc-Kommentar */
Android Studio hilft hier beim Formatieren: Dafür einfach „/**“ eingeben und Enter drücken. Es werden automatisch zwei neue Zeilen angefügt (beginnend mit „*“ und „*/“). Auch wenn man danach manuelle Umbrüche innerhalb des Javadoc-Kommentars macht, beginnt die neue Zeile jeweils wieder mit einem „*“.
Javadoc-Kommentar
Das Android-Kommentar-Cheatsheet
Dieses Cheatsheet ist bewusst einfach gehalten, sodass es nur die nötigsten Informationen enthält: Syntax-Beispiele für XML und Java. (Dabei ignoriere ich den „Sonderfall“ Javadoc.)
Cheatsheet: Kommentieren in XML und Java
Wenn dir dieser Post und/oder das Cheatsheet geholfen hat, dann schreib mir bitte einen Kommentar und teil den Post. Vielen Dank! 🙂
🙂 Klick hier für Bücher zum Thema Android-Programmierung!* 🙂