So verwenden Sie Kommentare in Java Progamming

In Java-Programmierung, gibt es einen Unterschied zwischen Code geschrieben für Maschinen und Code geschrieben von Menschen gelesen werden. Diese erste Auflistung ist sehr einfach und ist nur für Maschinen gedacht.

Paket org.allyourcode.myfirstproject-public class MyFirstJavaClass {/ *** @param args * / public static void main (String [] args) {javax.swing.JOptionPane.showMessageDialog (null, "Hallo") -}}

Diese zweite Eintrag hat eine verbesserte Version des Codes in der ersten Liste. Zusätzlich zu all den Schlüsselwörter, Bezeichner und Zeichensetzung, wobei diese zweite Eintrag hat Text, der für den Menschen gemeint ist zu lesen.

/ ** Listing 5-2 in * "Java für Android-Entwickler für Dummies" ** Urheberrecht 2013 Wiley Publishing, Inc. * Alle Rechte vorbehalten. * /Paket org.allyourcode.myfirstproject-/ *** MyFirstJavaClass zeigt ein Dialogfeld * auf dem Computerbildschirm. ** @author Barry Burd * @version 1.0 02/02/13 * @see java.swing.JOptionPane * /public class MyFirstJavaClass { / *** Der Ausgangspunkt der Ausführung. ** @param Args * (nicht verwendet.) * /public static void main (String [] args) {javax.swing.JOptionPane.showMessageDialog (null, "Hallo") - //Null?}}

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: Alles zwischen der Öffnung / * und die Schließ * / nur für das menschliche Auge.

    2-6 Zeilen in der zweiten Liste haben extra Sternchen (*). Sie sind extra weil diese Sternchen nicht erforderlich, wenn Sie einen Kommentar erstellen. Sie machen nur der Kommentar hübsch aussehen. Sie sind in der Auflistung enthalten, weil aus irgendeinem Grund, die meisten Java-Programmierer auf das Hinzufügen dieser zusätzlichen Sternchen bestehen.

  • End-of-line Kommentare: Der Text //Null? in der zweiten Liste ein Ende der Linie Kommentar - es mit zwei Schrägstrichen beginnt und geht zum Ende einer Zeile des Typs. Wieder einmal wird der Compiler übersetzen den Text nicht innerhalb einer End-of-Line-Kommentar.

  • Javadoc Kommentare: EIN javadoc Kommentar beginnt mit einem Schrägstrich und zwei Sternchen (/ **). Der zweite Eintrag hat zwei javadoc Kommentare - ein mit dem Text MyFirstJavaClass zeigt ein Dialogfeld. . . und eine andere mit dem Text Der Startpunkt. . . .

    EIN javadoc Kommentar ist eine besondere Art von traditionellen Kommentar: Es soll von den Leuten zu lesen, die noch nie auf dem Java-Code aussehen auch.

    Warten - das macht keinen Sinn. Wie kann man die javadoc Kommentare in der Liste sehen, wenn Sie nie auf der Liste sehen?

    Nun, mit ein paar Punkte und Mausklicks können Sie alle javadoc Kommentare in der zweiten Liste finden und sie in eine gut aussehende Webseite, wie in der Abbildung dargestellt.

    bild0.jpg

Um Dokumentationsseiten für Ihren eigenen Code zu machen, gehen Sie folgendermaßen vor:

  1. Setzen Sie Javadoc Kommentare in Ihrem Code.

  2. Aus dem Hauptmenü in Eclipse, wählen Sie Javadoc-Projekt generieren.

    Als Ergebnis wird das Javadoc-Generation-Dialogfeld.

  3. Im Dialogfeld Javadoc-Generation, wählen Sie das Eclipse-Projekt, dessen Code Sie zu dokumentieren.

  4. Noch im Dialogfeld Javadoc-Generation, beachten Sie den Namen des Ordners im Feld Ziel.

    Der Computer stellt die neu erstellte Dokumentation Seiten in diesem Ordner. Wenn Sie einen anderen Ordner vorziehen, können Sie den Ordnernamen Feld in diesem Reiseziel ändern.

  5. Klicken Sie auf Fertig stellen.

    Als Ergebnis erzeugt der Computer die Dokumentationsseiten.

Wenn Sie den Zielordner besuchen und doppelklicken Sie auf den neuen index.html Datei-Symbol, sehen Sie Ihre schönen (und informativ) Dokumentationsseiten.

Sie können durch den Besuch der Oracle-Website die Seiten der Dokumentation für Java-interne API-Klassen finden Java SE-Dokumentation auf einen Blick Seite. Java API enthält Tausende von Klassen, also nicht merken nicht die Namen der Klassen und ihre Methoden. Stattdessen besuchen Sie einfach diese Online-Dokumentation Seiten.

Ähnliche

Menü