CodeKommentare dienen als Kommunikationsbrücke zwischen Programmdesignern und Programmlesern und maximieren die Effizienz der Teamentwicklungszusammenarbeit. Dies ist auch einer der wichtigen Aspekte der Wartbarkeit des Programmcodes. Lassen Sie uns in diesem Artikel über die Codekommentarspezifikationen sprechen, die wir in der täglichen Entwicklung verwenden.
Codekommentare sind eine Kommunikationsbrücke zwischen Programmdesignern und Programmlesern und maximieren die Effizienz der Teamentwicklungszusammenarbeit. Dies ist auch einer der wichtigen Aspekte der Wartbarkeit des Programmcodes. Wir schreiben also keine Kommentare um des Schreibens willen. Lassen Sie uns als Referenz über die Codekommentarspezifikationen sprechen, die wir in der täglichen Entwicklung verwenden.
1. Einheitliches Kommentarformular
Konstruieren Sie Kommentare mit einem Stil mit einheitlicher Interpunktion und Struktur in der gesamten Anwendung. Wenn Sie in anderen Projekten feststellen, dass deren Anmerkungsspezifikationen von diesem Dokument abweichen, schreiben Sie Code gemäß dieser Spezifikation und versuchen Sie nicht, neue Spezifikationen in das etablierte Spezifikationssystem einzuführen.
2. Der Inhalt der Anmerkungen sollte präzise und präzise sein.
Der Inhalt sollte einfach, klar und präzise in der Bedeutung sein, um Unklarheiten zu vermeiden Die Anmerkung ist nicht nur nicht hilfreich, sondern auch schädlich.
Anmerkungsbedingungen:
1. Grundlegende Anmerkung
(a) Klasse (Schnittstelle) Annotation
(b) Konstruktor Annotation
(c) Methodenannotation
(d) GlobalKommentare für Variablen
(e) Kommentare für Felder/Attribute
Hinweis: Machen Sie einfache Kommentare für einfache Codes, und der Kommentarinhalt sollte 10 Wörter nicht überschreiten. Das war’s Darüber hinaus müssen die Getter- und Setter-Methoden des persistenten -Objekts oder des VO-Objekts nicht mit Anmerkungen versehen werden. Das spezifische Kommentarformat finden Sie im Beispiel unten.
2. Spezielle Kommentare sind erforderlich
(a) Typische Algorithmen müssen Kommentare haben.
(b) Es muss Kommentare geben, bei denen der Code unklar ist.
(c) Fügen Sie einen Kommentar hinzu, der die Änderung der Codeänderung angibt.
(d) Fügen Sie dem Code Kommentare hinzu, die aus Schleifen und logischen Verzweigungen bestehen.
(e) Die für andere bereitgestellte Schnittstelle muss ausführlich kommentiert werden.
Hinweis: Es gibt noch keine Beispiele für diese Art von Kommentarformat. Das spezifische Anmerkungsformat wird von Ihnen selbst definiert und der Anmerkungsinhalt muss genau und prägnant sein.
Kommentarformat:
1. Einzeiliger Kommentar: „//……“
2. Blockieren Kommentare: „/*
/**
* 类的描述
* @author Administrator
* @Time 2016-11-14:49:01
*
*/
public classTest extends Button {
……
}3. Dokumentkommentare: „/**
public class Test extends Button {
/**
* 构造方法 的描述
* @param name
* 按钮的上显示的文字
*/
public Test(String name){
……
}
}4. Javadoc-Kommentar-Tag-Syntax
@author Die Beschreibung der Klasse gibt den Autor an, der das Modul dieses Typs entwickelt hat
@version Die Beschreibung der Klasse gibt die Version des Moduls dieses Typs an
@see Die Beschreibung der Klasse, Attribute und Methoden bezieht sich auf die Steuerung. Das heißt, verwandte Themen
@param Beschreibung der Methode Beschreibung eines bestimmten Parameters in der Methode
@return Beschreibung der Methode Beschreibung des Rückgabewerts der Methode
@Exception Beschreibung der Methode Beschreibt die Ausnahmen, die die Methode auslösen kann
Referenzbeispiel:
1. Klassen-(Schnittstellen-)Anmerkung
Zum Beispiel:
public class Test extends Button {
/**
* 为按钮添加颜色
*@param color
按钮的颜色
*@return
*@exception (方法有异常的话加)
* @author Administrator
* @Time2012-11-20 15:02:29
*/
public voidaddColor(String color){
……
}
}2. Konstruktormethode Anmerkung
Zum Beispiel:
public final class String
implements Java.io.Serializable, Comparable<String>,CharSequence
{
/** The value is used for characterstorage. */
private final char value[];
/** The offset is the first index of thestorage that is used. */
private final int offset;
/** The count is the number of charactersin the String. */
private final int count;
/** Cache the hash code for the string */
private int hash; // Default to 0
……
}3. Methodenanmerkung
zum Beispiel
public class EmailBody implements Serializable{
private String id;
private String senderName;//发送人姓名
private String title;//不能超过120个中文字符
private String content;//邮件正文
private String attach;//附件，如果有的话
private String totalCount;//总发送人数
private String successCount;//成功发送的人数
private Integer isDelete;//0不删除 1删除
private Date createTime;//目前不支持定时 所以创建后即刻发送
privateSet<EmailList> EmailList;
……
}4 Anmerkung
z. B.:
5. Feld-/Attributkommentare
Zum Beispiel:
Tatsächlich werden die Spezifikationen von uns selbst festgelegt, solange alle im Team sie einheitlich befolgen und standardisieren, werden Sie gute Ergebnisse erzielen. Ich hoffe, dass es für Freunde hilfreich ist, die normalerweise keine Kommentare hinzufügen.
Das obige ist der detaillierte Inhalt vonDetaillierte Erläuterung der Java-Code-Kommentarspezifikationen (Power-Node-Organisation). Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!
