Wie schreibt man einen Javadoc -Kommentar??
Syntax
Zunächst müssen wir die grundlegende Syntax von Javadoc -Kommentaren in Java sehen. Wir haben also den einfachen Editor verwendet, um einige Javadoc -Kommentare hineinzugeben und die Darstellung der folgenden Darstellung im Bild anzuzeigen. Der autogenerierte Kommentar des Java -Dokuments beginnt mit einem speziellen Charakter wie einem Sternchen, und die erste Zeile des gesamten Kommentars könnte eine grüne Farbe haben. Sie können die Darstellung eines Java -Dokuments -Kommentars sehen, der zu Beginn jedes Kommentars von Anfang bis Ende viele Sternchen -Charaktere enthält.
Zu Beginn beginnt der Java -Doc -Kommentar mit dem „/“ -Scharakter, gefolgt von zwei Sternchenzeichen. Gleichzeitig enthalten alle anderen Linien zu Beginn ein einzelnes Sternchenzeichen. Am Ende eines Java -Dokument -Kommentars haben wir es mit dem „/“ -Scharakter beendet. Zwischen dieser Illustration des Java -Dokument -Kommentars sehen Sie eine Kommentarzeile „7“, in der wir den Namen eines Autors definiert haben, das das Zeichen „@“ verwendet, um eine Variable „Autor“ mit dem Namen eines Kommentarautors zu definieren, ich.e., Saeed Raza. Die Meta-Data-Informationen von Java-Dokument-Kommentaren müssen immer mit dem Charakter "@" geschrieben werden.
Erstellen Sie einen automatischen Java -DOC -Kommentar in Eclipse IDE
In diesem Beispiel wird die Eclipse IDE Java Development -Umgebung verwendet, um automatische Kommentare im Java -Projekt zu erstellen. Dafür müssen Sie eine Eclipse -IDE -IDE montiert und an Ihrem Ende einrichten. Starten Sie also die Eclipse IDE und erstellen Sie ein neues Projekt namens „Java“. Sie werden aufgefordert, das aktuelle Projektpaket zu benennen. Wir haben es auch "Java" genannt. Danach müssen Sie eine neue Java -Datei erstellen oder eine neue Klasse innerhalb desselben Java -Projekts erstellen. Zu diesem Zeitpunkt finden Sie rechtzeitig den Paketnamen aus der linken Ecke der Eclipse IDE-Projekt-Explorer-Leiste, wandeln Sie sich zur Option "Neu" und klicken Sie auf das Schlüsselwort "Klasse" aus den erweiterten Optionen. Dadurch wird ein neues Fenster auf Ihrem Bildschirm mit dem Titel „New Java Class“ generiert, wie im Bild unten angezeigt.
Jetzt müssen Sie den Namen einer Klasse einfügen, die im Textfeld vor dem Label "Name" erstellt werden soll. Die meisten Dinge bleiben unverändert, da diese automatisch ausgewählt wurden, wenn Sie versuchen, eine neue Klasse zu erstellen. Sie müssen nur die Methode -End löschen, die Sie für Ihren Java -Code erstellen möchten. Daher haben wir das erste Kontrollkästchen überprüft, um eine Main () -Treiberfunktion in dieser Klasse zu erstellen. Last but not least finden Sie die Möglichkeit, die Standardkommentare im Java -Programm hinzuzufügen, das erstellt werden soll. Sie müssen nur das Kontrollkästchen „Kommentare generieren“ überprüfen. Dies wird ein phänomenaler Schritt bei der Erstellung von Java -Code sein. Lassen Sie uns die Schaltfläche „Finish“ drücken, nachdem wir alle erforderlichen Informationen bereitgestellt haben.
Das Java-Programm für das DIGED-Below wurde im Eclipse IDE-Tool zusammen mit automatischen Kommentaren erstellt. Sie können sehen, dass die Kommentare von Java Doc alle mit den Sternchenfiguren begannen. Es liefert auch Meta-Data-Informationen zum Projekt, ich.e., der Autor. Zusammen mit dem zeigt es auch, dass der automatische Kommentar zeigt, dass wir auch eine Stub -Hauptfunktion erstellt haben. Hier geht es um die automatische Generation von Javadoc -Kommentaren in Eclipse IDE.
Beispiel 01: Javadoc -Kommentare
Jetzt können Sie Ihre eigenen Java -Dokument -Kommentare erstellen, während Sie codieren. Hier ist eine weitere Illustration, um das zu tun. Wann immer Sie die main () -Treiberfunktion im Code verwendet haben, i.e., Sie sollten es in jedem einzelnen Programm verwenden, Sie sollten seinen Kommentar immer oben in der Datei erstellen oder in dieser Funktion wie "// Todo automatisch generierte Methodenstub" beginnen. In diesem Kommentar wird erklärt, dass die main () -Methode automatisch generiert wurde, ich.e., Sie müssen es nicht schreiben.
Danach haben wir einen Javadoc-langen Kommentar hinzugefügt, der die Verwendung dieses Programms zusammen mit den Meta-Daten-Informationen zur Verwendung dieses Programms erläutert.e., Autor, Version und das Datum, an dem es erstellt wurde. Vor der Anweisung "println" gibt es eine einzige Zeile von Kommentaren, mit denen der Zweck der Verwendung der funteLn () -Funktion erklärt wird. Das war's für dieses Beispiel.
Die Ausführung von Programmen mit Kommentaren beeinflusst die Ausgabe nicht wie unten.
Beispiel 01: Einzellinien- und Multiline-Kommentare
Nachdem wir die Javadoc-Kommentare in Eclipse IDE durchgemacht haben, werfen wir einen weiteren Beispiel für Java unter Verwendung der Einzellinien- und Multi-Line-Kommentare an, ich.e., benutzerdefinierte. Wir haben jetzt eine neue Klasse „Test“ generiert und die Main () -Methode in sie eingeschlossen. Diese Methode enthält eine println () -Funktionserklärung, um etwas anzuzeigen. Wir haben einen einzelnen Kommentar mit dem Namen einer Klasse verwendet, die mit "//" -Scharakteren beginnt, ich.e., erklärt, dass es Klasseninitialisierung ist. In der Funktion main () Funktionsdefinition wurde ein Multi-Line-Kommentar hinzugefügt, beginnend mit den Zeichen "/*" und endet mit "*/" Zeichen.
Abschluss
Dieser Artikel hilft Ihnen, die Bedeutung und Vitalität von Kommentaren zu verstehen, die im täglichen Leben und im Programmierleben verwendet werden. Es wird erläutert, wie diese Kommentare Ihnen in vielerlei Hinsicht helfen können. Erstens haben wir besprochen, was die Javadoc -Kommentare sind und ihre Syntax sehr kurz erklärt haben. Danach haben wir die gesamte Methode in Eclipse IDE erklärt, die automatischen Javadoc -Kommentare innerhalb weniger Sekunden und mit ein paar Klicks auf der GUI zu generieren.