Persönliche Kommentarkriterien [Java Edition]

Falls Sie gefragt werden: "Nach welchen Kriterien kommentieren Sie?" Ich habe es in ungefähr 30 Minuten geschrieben, also denke ich, dass es viele Auslassungen gibt, aber irgendwie sieht es so aus.

Javadoc Grundsätzlich anziehen. Privat hat eine etwas niedrigere Priorität, sollte jedoch so weit wie möglich hinzugefügt werden, insbesondere wenn es sich um eine Methode handelt. Verwenden Sie viele von Javadoc bereitgestellte Mechanismen (z. B. Rückgabe) und niemals tagähnliche Dinge.

F. Privates Javadoc bedeutet nicht, dass Dokumente erstellt werden. Bist du dumm? A. Es wird automatisch generiert und ich habe eine Ahnung. Und ich werde einige ergänzende Tipps in Javadoc aufgreifen. Erst nachdem der ganzen Menschheit Weisheit gegeben wurde, kann gesagt werden, dass alle Variablennamen verwaltet werden können.

Normal Es wird nach folgenden Kriterien angehängt.

Rewrite Schreiben Sie Kommentare wie die folgenden um oder entfernen Sie sie, wenn möglich. Wenn die Wörter "** get " und " set **" erscheinen, werden sie normalerweise ausgeschlossen.

[^ 1]: Neigt dazu, halbe Hündinnen zu sein. Kaninchenwinkel kurz. [^ 2]: Da der Inhalt Inhalt ist, ist er in der Regel wieder lang. Sie sollten das Material vorbereiten und dort schreiben. [^ 3]: Hibernate Validator. [^ 4]: Überprüfung der E-Mail-Adresse. [^ 5]: Was denkst du wirklich über die Tatsache, dass "serialVersionUID" insbesondere in serialVersionUID geschrieben ist? Denkst du an irgendetwas? [^ 6]: Ich frage mich, ob ich die Javadoc-Spezifikationen gelesen habe. Ich konnte es wohl nicht lesen. [^ 7]: Glücklicherweise passiert "es wurde zerstört, obwohl wichtige Dinge auf der Schnittstellenseite geschrieben wurden" nicht unerwartet. Es ist normalerweise eine Kopie.

Recommended Posts

Persönliche Kommentarkriterien [Java Edition]
Java-Dokumentation Kommentar
Java statisch [Persönliche Zusammenfassung]
Persönliche Zusammenfassung über Java
Aktualisierungen von Effective Java Third Edition 2nd Edition Persönliche Notizen
Modern Java Development Guide (Ausgabe 2018)
Java-Kommentaranzahl (VBA-Material)
Java HashMap, entrySet [Persönliches Memo]
JAVA (Erster Schritt: Git Bush Edition)
Persönliches Memo: Metaprogrammierung mit Java-Reflexion
Effektive Java 3rd Edition Kapitel 5 Generika
AtCoder 400 Punkte Algorithmus Zusammenfassung (Java Edition)
Effektive Java 3rd Edition Kapitel 8 Methoden