Mahnazmezon

Java-Kommentare verwenden

Wissenschaft
Share

Java-Kommentare sind Notizen in einer Java-Codedatei, die vom Compiler und der Laufzeit-Engine ignoriert werden. Sie werden zum Kommentieren des Codes verwendet, um dessen Design und Zweck zu verdeutlichen. Sie können einer Java-Datei eine unbegrenzte Anzahl von Kommentaren hinzufügen. Bei der Verwendung von Kommentaren sind jedoch einige bewährte Methoden zu beachten.

Im Allgemeinen sind Codekommentare "Implementierungskommentare", die den Quellcode erläutern, z. B. Beschreibungen von Klassen, Schnittstellen, Methoden und Feldern. Dies sind normalerweise ein paar Zeilen, die über oder neben Java-Code geschrieben sind, um zu verdeutlichen, was er tut.

Eine andere Art von Java-Kommentar ist ein Javadoc-Kommentar. Javadoc-Kommentare unterscheiden sich in der Syntax geringfügig von Implementierungskommentaren und werden vom Programm javadoc.exe zum Generieren von Java-HTML-Dokumentation verwendet.

Gründe für die Verwendung von Java-Kommentaren?

Gewöhnen Sie sich an, Java-Kommentare in Ihren Quellcode einzufügen, um die Lesbarkeit und Übersichtlichkeit für Sie und andere Programmierer zu verbessern. Es ist nicht immer sofort klar, was ein Abschnitt von Java-Code ausführt. Ein paar erklärende Zeilen können den Zeitaufwand für das Verstehen des Codes drastisch reduzieren.

Beeinflussen sie die Programmausführung??

Implementierungskommentare in Java-Code sind nur für Menschen lesbar. Java-Compiler kümmern sich nicht um sie, und wenn sie das Programm kompilieren, überspringen sie sie einfach. Die Größe und Effizienz Ihres kompilierten Programms wird nicht durch die Anzahl der Kommentare in Ihrem Quellcode beeinflusst.

Implementierungskommentare

Implementierungskommentare gibt es in zwei verschiedenen Formaten:

  • Zeilenkommentare: Geben Sie für einen einzeiligen Kommentar "//" ein und folgen Sie den beiden Schrägstrichen mit Ihrem Kommentar. Beispielsweise: 
     // Dies ist ein einzeiliger Kommentar
    int guessNumber = (int) (Math.random () * 10);
    Wenn der Compiler auf die beiden Schrägstriche stößt, weiß er, dass alles rechts von ihnen als Kommentar zu betrachten ist. Dies ist beim Debuggen eines Codeteils hilfreich. Fügen Sie einfach einen Kommentar aus einer Codezeile hinzu, die Sie debuggen, und der Compiler kann ihn nicht sehen:
    •  // Dies ist ein einzeiliger Kommentar
      // int guessNumber = (int) (Math.random () * 10);
      Sie können auch die beiden Schrägstriche verwenden, um einen Kommentar zum Zeilenende zu verfassen:
    •  // Dies ist ein einzeiliger Kommentar
      int guessNumber = (int) (Math.random () * 10); // Ein Kommentar zum Zeilenende
  • Kommentare blockieren: Um einen Blockkommentar zu starten, geben Sie "/ *" ein. Alles zwischen dem Schrägstrich und dem Sternchen, auch wenn es sich in einer anderen Zeile befindet, wird als Kommentar behandelt, bis die Zeichen "* /" den Kommentar beenden. Beispielsweise: 
     /* Dies
    ist
    ein
    Block
    Kommentar
    * /
    /* also das ist */

Javadoc-Kommentare

Verwenden Sie spezielle Javadoc-Kommentare, um Ihre Java-API zu dokumentieren. Javadoc ist ein im JDK enthaltenes Tool, das aus Kommentaren im Quellcode HTML-Dokumentation generiert.

Ein Javadoc-Kommentar in 

.Java
 Quelldateien sind in Start- und End-Syntax wie folgt eingeschlossen: 
/ **
 und 
* /
. Jedem Kommentar in diesen Feldern ist ein vorangestelltes 
*
. 

Platzieren Sie diese Kommentare direkt über der Methode, Klasse, dem Konstruktor oder einem anderen Java-Element, das Sie dokumentieren möchten. Beispielsweise:

// myClass.java
/ **
* Machen Sie daraus einen zusammenfassenden Satz, der Ihre Klasse beschreibt.
* Hier ist eine andere Zeile.
* /
Öffentlichkeit Klasse meine Klasse

…

Javadoc enthält verschiedene Tags, die steuern, wie die Dokumentation generiert wird. Zum Beispiel die 

@param
 Tag definiert Parameter für eine Methode: 
 / ** Hauptmethode
* @param args String []
* /
Öffentlichkeit statisch Leere main (String [] args)

System.out.println ("Hallo Welt!");

In Javadoc sind viele andere Tags verfügbar. Außerdem werden HTML-Tags unterstützt, um die Ausgabe zu steuern. Weitere Informationen finden Sie in Ihrer Java-Dokumentation.

Tipps zum Verwenden von Kommentaren

  • Überkommentiere nicht. Jede Zeile Ihres Programms muss nicht erklärt werden. Wenn Ihr Programm logisch abläuft und nichts Unerwartetes auftritt, müssen Sie keinen Kommentar hinzufügen.
  • Kommentar einrücken. Wenn die Codezeile, die Sie kommentieren, eingerückt ist, stellen Sie sicher, dass Ihr Kommentar mit dem Einzug übereinstimmt.
  • Halten Sie Kommentare relevant. Einige Programmierer sind hervorragend darin, Code zu ändern, aber vergessen Sie aus irgendeinem Grund, die Kommentare zu aktualisieren. Wenn ein Kommentar nicht mehr gültig ist, ändern oder entfernen Sie ihn.
  • Blockkommentare nicht verschachteln. Folgendes führt zu einem Compilerfehler: 
     /* Dies
    ist
    / * Dieser Blockkommentar beendet den ersten Kommentar * /
    ein
    Block
    Kommentar
    * /
Wissenschaft
×