Hinzufügen von Kommentaren zu Java-Code
Diese Java-Eintrag hat eine verbesserte Version eines Beispielprogramm. Zusätzlich zu all den Schlüsselwörter, Bezeichner und Zeichensetzung, es hat Text, der für den Menschen zu lesen, gemeint ist.
/ ** Listing 3-6 in "Java for Dummies, 6. Auflage" ** Urheberrecht 2014 Wiley Publishing, Inc. * Alle Rechte vorbehalten. * // *** Die Displayer Klasse zeigt Text * auf dem Computer-Bildschirm. ** @ Autor Barry Burd * @version 1.0 10. / 24/13 * @see java.lang.System * / public class Displayer {/ *** die wichtigste Methode ist, wobei * die Ausführung des Codes beginnt. ** @param args (siehe Kapitel . 11) * / public static void main (String args []) {System.out.println ( "ich liebe Java!") - // ich? Sie?}}EIN Kommentar ist ein besonderer Abschnitt von Text in einem Programm, dessen Ziel ist es, Menschen das Programm verstehen zu helfen. Ein Kommentar ist Teil eines guten Programms Dokumentation.
Die Programmiersprache Java hat drei Arten von Kommentaren:
Traditionelle Kommentare: Die ersten fünf Zeilen der Liste Form eines traditionell Kommentar. Der Kommentar beginnt mit / * und endet mit * /. Alles zwischen der Öffnung / * und die Schließ * / nur für das menschliche Auge. Keine Informationen über "Java for Dummies, 6. Auflage" oder Wiley Publishing, Inc. wird vom Compiler übersetzt.
Die zweite, dritte, vierte und fünfte Zeile in Listing 3-6 haben extra Sternchen (*). Sie sind besonders genannt, weil diese Sternchen sind nicht erforderlich, wenn Sie einen Kommentar erstellen. Sie machen nur den Kommentar hübsch aussehen.
End-of-line Kommentare: Der Text //ICH? Du? in der Auflistung ist ein Ende der Linie Kommentar. Eine End-of-Line-Kommentar beginnt mit zwei Schrägstrichen und geht zum Ende einer Zeile des Typs. Wieder einmal wird der Compiler übersetzen den Text nicht in der End-of-Line-Kommentar.
Javadoc Kommentare: EIN javadoc Kommentar beginnt mit einem Schrägstrich und zwei Sternchen (/ **). Die Auflistung hat zwei javadoc Kommentare - ein mit dem Text Die Displayer Klasse. . . und eine andere mit dem Text Die wichtigste Methode ist, wo. . . .
Ein javadoc Kommentar ist eine besondere Art von traditionellen Kommentar. Ein javadoc Kommentar soll von Menschen gelesen werden, die noch nie den Java-Code zu sehen. Aber das macht keinen Sinn. Wie kann man die javadoc Kommentare sehen?
Nun, ein bestimmtes Programm aufgerufen javadoc (Was sonst?) Können alle javadoc Kommentare in der Liste zu finden und diese Kommentare in eine gut aussehende Webseite drehen. Diese Abbildung zeigt die Seite.
Javadoc Kommentare sind groß. Hier sind einige großartige Dinge über sie:
Die einzige Person, die auf einem Stück von Java-Code zu suchen hat, ist der Programmierer, der den Code schreibt. Andere Leute, die den Code verwenden können, finden Sie heraus, was der Code tut, indem Sie die automatisch generierte Web-Seite ansehen.
Weil andere Menschen auf der Java-Code nicht aussehen, andere Leute Änderungen nicht auf den Java-Code. (Mit anderen Worten, andere Personen vorstellen keine Fehler in den vorhandenen Java-Code.)
Weil andere Menschen auf der Java-Code nicht aussehen, andere Leute haben nicht das Innenleben des Java-Code zu entschlüsseln. All diese Menschen müssen wissen, über den Code ist, was sie auf den Code der Webseite lesen.
Der Programmierer erstellt nicht zwei verschiedene Dinge - einige Java-Code hier und eine Dokumentation über den Code dort. Stattdessen erzeugt der Programmierer ein Stück Java-Code und bettet die Dokumentation (in Form von javadoc Kommentare) direkt in den Code.
Best of all, die Erzeugung von Web-Seiten von javadoc Kommentare automatisch. So kann jeder in der Dokumentation hat das gleiche Format. Egal, deren Java Code, den Sie verwenden, finden Sie diesen Code aus, indem Sie eine Seite wie in der Figur zu lesen. Das ist gut, weil das Format jedem vertraut ist, die Java verwendet.