Hinzufügen von Kommentaren zu Java Code - Dummies

Diese Java-Auflistung verfügt über eine erweiterte Version eines Beispielprogramms. Zusätzlich zu allen Schlüsselwörtern, Bezeichnern und Interpunktionen hat es Text, der für den Menschen zum Lesen bestimmt ist.

/ * * Auflistung 3-6 in "Java für Dummies, 6. Ausgabe" * * Copyright 2014 Wiley Publishing, Inc. * Alle Rechte vorbehalten. * / / ** * Die Displayer-Klasse zeigt Text * auf dem Computerbildschirm an. * * @author Barry Burd * @version 1. 0 10/24/13 * @see java. lang. System * / public class Displayer {/ ** * Die Hauptmethode ist, wo * die Ausführung des Codes beginnt. * * @param args (Siehe Kapitel 11.) * / public static void main (Zeichenfolge args []) {System. aus. println ("Ich liebe Java!"); //ICH? Sie?}}

Ein Kommentar ist ein spezieller Textabschnitt in einem Programm, dessen Zweck es ist, den Leuten zu helfen, das Programm zu verstehen. Ein Kommentar ist Teil einer guten Programmdokumentation.

Die Java-Programmiersprache hat drei Arten von Kommentaren:

• Traditionelle Kommentare: Die ersten fünf Zeilen der Liste bilden einen traditionellen Kommentar. Der Kommentar beginnt mit / * und endet mit * /. Alles zwischen der Öffnung / * und dem Schließen * / ist nur für menschliche Augen. Keine Informationen zu "Java for Dummies, 6. Ausgabe" oder Wiley Publishing, Inc. werden vom Compiler übersetzt.

  Die zweite, dritte, vierte und fünfte Zeile in Listing 3-6 haben zusätzliche Sternchen (*). Sie werden als Extra bezeichnet, da diese Sternchen beim Erstellen eines Kommentars nicht erforderlich sind. Sie lassen den Kommentar nur hübsch aussehen.

• Zeilenende-Kommentare: Der Text // I? Du? In der Liste ist ein End-of-Line Kommentar. Ein Zeilenende-Kommentar beginnt mit zwei Schrägstrichen und geht bis zum Ende einer Zeile des Typs. Wiederum übersetzt der Compiler den Text nicht in den End-of-Line-Kommentar.

• Javadoc Kommentare: Ein Javadoc Kommentar beginnt mit einem Schrägstrich und zwei Sternchen (/ **). Die Auflistung hat zwei Javadok-Kommentare - eine mit dem Text Die Displayer-Klasse … und eine andere mit dem Text Die Hauptmethode ist wo ….

  Ein Javadok-Kommentar ist eine besondere Art von traditionellem Kommentar. Ein Javadoc-Kommentar soll von Leuten gelesen werden, die niemals den Java-Code betrachten. Aber das macht keinen Sinn. Wie können Sie die Kommentare von Javadoc sehen?

  Nun, ein bestimmtes Programm namens javadoc (was sonst?) Kann alle Javadoc-Kommentare in der Auflistung finden und diese Kommentare in eine nett aussehende Webseite verwandeln. Diese Abbildung zeigt die Seite.

  

Javadoc-Kommentare sind großartig. Hier sind einige großartige Dinge über sie:

• Die einzige Person, die sich einen Teil des Java-Codes ansehen muss, ist der Programmierer, der den Code schreibt.Andere Personen, die den Code verwenden, können anhand der automatisch generierten Webseite herausfinden, was der Code tut.

• Da andere Leute den Java-Code nicht ansehen, ändern andere Leute den Java-Code nicht. (Mit anderen Worten, andere Personen fügen keine Fehler in den vorhandenen Java-Code ein.)

• Da andere Leute den Java-Code nicht sehen, müssen andere Leute nicht die innere Funktionsweise des Java-Codes entschlüsseln. Alle diese Leute müssen über den Code wissen, was sie auf der Webseite des Codes lesen.

• Der Programmierer erstellt keine zwei separaten Dinge - einen Java-Code hier und eine Dokumentation über den Code da drüben. Stattdessen erstellt der Programmierer ein Stück Java-Code und bettet die Dokumentation (in Form von Javadoc-Kommentaren) direkt in den Code ein.

• Und das Beste: Die Generierung von Webseiten aus Javadoc-Kommentaren erfolgt automatisch. So hat jedermanns Dokumentation das gleiche Format. Unabhängig davon, welchen Java-Code Sie verwenden, erfahren Sie diesen Code, indem Sie eine Seite wie die in der Abbildung lesen. Das ist gut, weil das Format jedem vertraut ist, der Java benutzt.