[Java] Arten von Kommentaren und wie man sie schreibt

: Anfänger: Ich habe jedes Mal in der Quellenübersicht über das Newcomer-Training darauf hingewiesen, also habe ich versucht, es für Newcomer zu organisieren: Anfänger:

Java-Kommentartypen

So schreiben Sie einen einzeiligen Kommentar

//Kommentar

Mit Eclipse können Sie es mit Strg + / hinzufügen oder entfernen.

So schreiben Sie einen mehrzeiligen Kommentar

/*
*Ein Stern am Anfang
* comment
*/

JavaDoc

/**
 *Beschreibung der Klasse oder Methode
 *Am Anfang befinden sich zwei Sternchen.
 */

Ein besonderer Kommentar, der sich von den beiden oben genannten unterscheidet. JavaDoc-Kommentare können mit Java-Befehlen = Referenzhandbuch dokumentiert werden. Daher können verschiedene Tags verwendet werden. Es ist ein Handbuch, verwenden Sie es also nicht, wenn Sie eine kleine Erklärung in den Quellcode schreiben.

Tag-Beispiel

Etikett Erläuterung
@param Beschreibung der Parameter (Argumente).
@return Eine Beschreibung des Rückgabewerts.
@author Eine Beschreibung des Erstellers des Programms.
@throw Eine Beschreibung der ausgelösten Ausnahmen.

Recommended Posts

[Java] Arten von Kommentaren und wie man sie schreibt
Wie schreibe ich einen Java-Kommentar
Grundlagen der Java-Entwicklung ~ Schreiben von Programmen (Variablen und Typen) ~
[Java] Wie man Dateien ausgibt und schreibt!
JDBC Versprechen und Schreibbeispiel
So schreiben Sie Kommentare in die Schemadefinitionsdatei in GraphQL Java und spiegeln sie in GraphiQL und GraphQL Playground wider
Wie schreibe ich Scala aus der Perspektive von Java
Grundlagen der Java-Entwicklung ~ So schreiben Sie ein Programm (Ablauf und bedingte Verzweigung) ~
Java # 6 studieren (Wie man Blöcke schreibt)
So schreiben Sie eine Java-Variablendeklaration
Vergleich des Schreibens von Callback-Funktionen (Java, JavaScript, Ruby)
Schreiben und Notizen bei der Migration von VB zu JAVA
[java] Zusammenfassung des Umgangs mit char
Zusammenfassung zum Schreiben von Anmerkungsargumenten
[Einführung in Java] So schreiben Sie ein Java-Programm
[Java] [Maven3] Zusammenfassung der Verwendung von Maven3
[Einführung in Java] Informationen zu Variablendeklarationen und -typen
Offline in Echtzeit, wie man ein Java-Implementierungsbeispiel für ein F01-Problem schreibt
Java Anfänger Escape Boot Camp Teil 1 Struktur und Schreiben der Java-Klasse
[Java] Beachten Sie, wie Sie RecyclerView verwenden und die animierte Swipe-Verarbeitung implementieren.
[Java-Verbesserungsfall] Wie man die Grenze des Selbststudiums und darüber hinaus erreicht
Java8 / 9-Anfänger: Streamen Sie API-Suchtpunkte und wie Sie damit umgehen
[Java] Verwendung der FileReader-Klasse und der BufferedReader-Klasse
[java] Zusammenfassung des Umgangs mit Zeichenketten
Grundlagen der Java-Entwicklung ~ Schreiben von Programmen * Übung 1 ~
[Java] Zusammenfassung, wie Lambda-Ausdrücke weggelassen werden
Wie man Java SE8 Gold bekommt und studiert
[Java] Memo zum Schreiben der Quelle
Wie schreibe ich Java String # getBytes in Kotlin?
So greifen Sie auf Java Private-Methoden und -Felder zu
Hinweise zum Schreiben von Kommentaren auf Englisch
[Java] Verwendung der Kalenderklasse und der Datumsklasse
Wie schreibe ich Rails
Java - Vereinigung von Kommentaren
Wie schreibe ich Docker-Compose
Wie schreibe ich Mockito
So schreiben Sie eine Migrationsdatei
[Java] Variablen- und Typtypen
Unterschied zwischen Java, C # und JavaScript (wie man den Grad der Fettleibigkeit findet)
[Java] So erhalten Sie die URL der Übergangsquelle
[Rails, JS] So implementieren Sie die asynchrone Anzeige von Kommentaren
java: Wie schreibe ich eine generische Typliste? [Hinweis]
[Java] So erhalten Sie den Maximalwert von HashMap
Lesen von Java Memory Management und GC Viewer
Stand April 2018 So installieren Sie Java 8 auf einem Mac
Zusammenfassung der Java-Kommunikations-API (1) Verwendung von Socket
Ich habe die Typen und Grundlagen von Java-Ausnahmen zusammengefasst
Zusammenfassung der Java-Kommunikations-API (3) Verwendung von SocketChannel
So konvertieren Sie A in a und a in A mit logischem Produkt und Summe in Java
Zusammenfassung der Java-Kommunikations-API (2) Verwendung von HttpUrlConnection
Zusammenfassung der Implementierung von Standardargumenten in Java
Wie man modernes Java schreibt. Unveränderliches Java, Null Betrachten Sie die Sicherheit.
Äquivalenter Vergleich von Java-Wrapper-Klasse und primitivem Typ