Für Programmentwickler ist es sehr wichtig, Kommentare an Code anzuhängen. Mit der Entwicklung der Technologie müssen Programmierer verpflichtet sein, während der Projektentwicklung Codekommentare zu schreiben, was dem anschließenden Schreiben und Gebrauch von Code förderlich ist.
Grundlegende Anforderungen:
1. Einheitliches Kommentarformular
Verwenden Sie in der Anwendung Stile mit konsistenter Interpunktion und Struktur, um Anmerkungen zu konstruieren. Wenn Sie feststellen, dass sich ihre Annotationsspezifikationen in anderen Projekten von diesem Dokument unterscheiden, schreiben Sie Code nach dieser Spezifikation und versuchen Sie nicht, neue Spezifikationen in das festgelegte Spezifikationssystem einzuführen.
2. Der Kommentarinhalt ist korrekt und präzise
Der Inhalt sollte einfach, klar und genau sein, und die Bedeutung sollte von der Unklarheit von Kommentaren verhindert werden. Falsche Kommentare sind nicht nur nutzlos, sondern auch schädlich.
3. Grundlegende Kommentare (müssen hinzugefügt werden)
(a) Kommentare zur Klasse (Schnittstelle)
(b) Kommentar des Konstruktors
(c) Kommentare zu Methoden
(d) Kommentare globaler Variablen
(e) Hinweise für Felder/Attribute: Einfacher Code macht einfache Kommentare, der Kommentarinhalt ist nicht mehr als 10 Wörter und zusätzlich bestehen Objekte oder bestehen
Die Getter- und Setter -Methoden von VO -Objekten müssen nicht kommentiert werden. Für bestimmte Kommentarformate finden Sie auf den folgenden Beispielen.
4.. Spezielle Kommentare müssen hinzugefügt werden (müssen hinzugefügt werden)
(a) Typische Algorithmen müssen kommentiert werden.
(b) Kommentare müssen im unklaren Code abgegeben werden.
(c) Fügen Sie der Änderung der Änderung einen Kommentar bei der Codeänderung hinzu.
(d) Kommentar im Code aus Schleifen und logischen Zweigen.
(e) Die Schnittstellen, die anderen zur Verfügung gestellt werden, müssen ausführlich kommentiert werden.
Hinweis: Es gibt keine Beispiele für diese Art von Kommentarformat. Das spezifische Annotationsformat wird von Ihnen selbst definiert, und der Annotationsinhalt ist erforderlich, um genau und präzise zu sein.
5. Kommentarformat:
1) Einzelzeilenkommentar: "// ..."
2) Block Kommentar: "/*...*/"
3) Dokument -Kommentare: "/** ...*/"
4) Javadoc Kommentar -Tag -Syntax
@Author Die Beschreibung der Klasse gibt den Autor an, der das Modul der Klasse entwickelt hat
@Version Die Beschreibung der Klasse zeigt die Version des Moduls der Klasse an
@see Referenz wenden Sie sich an die Beschreibung von Klassen, Eigenschaften und Methoden, dh verwandte Themen
@param Beschreibung der Methode Beschreibung eines Parameters in einer Methode
@Return Beschreibung der Methode Beschreibung des Methodenrückgabewerts
@Exception Beschreibung der Methode Beschreibung der Ausnahmen, die mit der Methode geworfen werden können
6. Beispiel:
/** Erstellen Sie eine Werkzeugklasse zum Manipulieren von Arrays, die diese gemeinsame Funktion für Betriebsarrays enthält: am meisten. @Author Zhang san @Version v. */ public class arraytool {/ ** den maximalen Wert des forming array @param arr empfangen ein Array von Elementen von int type @return den maximalen Elementwert des Array */ public intmax (int arr) {int max =; MAX zurückgeben; }}Geben Sie den Befehl wie unten gezeigt ein:
Überprüfen Sie es dann im folgenden Verzeichnis und klicken Sie schließlich auf index.html:
Der obige Inhalt teilt Ihnen Java -Code -Kommentarspezifikationen mit, in der Hoffnung, dass es Ihnen hilfreich ist.