[JAVA] Hinweise zum Schreiben von Kommentaren auf Englisch

Einführung

Da die Programmkommentare grundsätzlich in englischer Sprache verfasst sind Machen Sie sich eine Notiz

Kommentar zum Klassenkopf

Klasse von Systemen, die Informationen enthalten

/**
 * This class is used to hold the ***.
 */

Klasse des zu liefernden Systems

/**
 * Provides ***.
 */

Schnittstellenklasse

/**
 * Defines a *** interface.
 * That any implementation of this interface can be used by inheritor's to handle a ***.
 */

Methodenkommentar

Flaggeneinstellung bezogen

/**
 * Sets flag indicating whether *** is ***.
 */

Urteilsbeziehung

/**
 * Determines if *** is *** or not.
 *
 * @return Returns {@code true} if *** is ***, {@code false} otherwise.
 */

Urteilsbeziehung 2

/**
 * Checks whether the given *** can be ***.
 *
 * @return Returns {@code true} if the given *** can be ***, {@code false} if they cannot be ***.
 */

Beziehung, um etwas zu bekommen

/**
 * Gets the *** with the given {@code ***}.
 *
 * @return Returns the ***. Returns {@code null} if *** doesn't have a specified ***.
 */

Andere

Aufzählungssystem

/**
 * Enumeration for ***.
 */

Recommended Posts

Hinweise zum Schreiben von Kommentaren auf Englisch
Wie schreibe ich einen Java-Kommentar
[Ruby on Rails] Wie schreibe ich eine Enumeration auf Japanisch?
Hinweise zur Verwendung regulärer Ausdrücke in Java
Wie schreibe ich Rails
JUnit 5: Wie man Testfälle in enum schreibt
Hinweise zur Verwendung der einzelnen JUnit-Regeln
Wie schreibe ich Docker-Compose
Wie schreibe ich Mockito
So schreiben Sie eine Migrationsdatei
[Java] Memo zum Schreiben der Quelle
Wie schreibe ich Java String # getBytes in Kotlin?
Hinweise zum Erstellen von Burp Suite-Erweiterungen
Javaer fasst zusammen, wie C # -Eigenschaften geschrieben werden
[Java] Arten von Kommentaren und wie man sie schreibt
[Ruby On Rails] So setzen Sie die Datenbank in Heroku zurück
So schreiben Sie eine Datumsvergleichssuche in Rails
Wie schreibe ich einen Core Mod in Minecraft Forge 1.15.2
Wie man guten Code schreibt
Wie man mit Heroku einsetzt
[Refactoring] So schreiben Sie Routing
Wie schreibe ich Junit 5 organisiert
Wie schreibe ich Rails Seed
Wie schreibe ich Rails Routing
Schreiben und Notizen bei der Migration von VB zu JAVA
So wechseln Sie Java in der OpenJDK-Ära auf dem Mac
[Rails 5] japanMap-Link So schreiben Sie Parameter in die js.erb-Datei
[Rails] So schreiben Sie user_id (externer Schlüssel) in einen starken Parameter
So schreiben Sie Kommentare in die Schemadefinitionsdatei in GraphQL Java und spiegeln sie in GraphiQL und GraphQL Playground wider
Wie man Lombok im Frühling benutzt
So finden Sie May'n in XPath
So blenden Sie die Bildlaufleiste in WebView aus
So führen Sie JUnit in Eclipse aus
Wie man in Ruby auf unbestimmte Zeit iteriert
Java # 6 studieren (Wie man Blöcke schreibt)
Wie man eine Ansicht auf Android "aushöhlt"
Wie man Ant in Gradle ausführt
Wie man die Programmierung in 3 Monaten beherrscht
Verwendung von Ruby on Rails
So stellen Sie Bootstrap auf Rails bereit
So führen Sie JavaFX unter Docker aus
Wie man JAVA in 7 Tagen lernt
So erhalten Sie Parameter in Spark
Verwendung von Bio-Formaten unter Ubuntu 20.04
So installieren Sie Bootstrap in Ruby