Explication détaillée des spécifications des commentaires du code Java (organisation des nœuds de puissance)

Le

CodeCommentaires sert de pont de communication entre les concepteurs de programmes et les lecteurs de programmes, maximisant l'efficacité de la coopération au développement des équipes. C'est également l'un des aspects importants de la maintenabilité du code du programme. Parlons des spécifications de commentaires de code que nous utilisons dans le développement quotidien à travers cet article

Les commentaires de code sont un pont de communication entre les concepteurs de programmes et les lecteurs de programmes, maximisant l'efficacité de la coopération de développement en équipe. C'est également l'un des aspects importants de la maintenabilité du code du programme. Nous n’écrivons donc pas de commentaires pour le plaisir d’écrire des commentaires. Parlons des spécifications de commentaires de code que nous utilisons dans le développement quotidien pour votre référence.

1. Formulaire de commentaire uniforme

Construisez des commentaires en utilisant un style avec une ponctuation et une structure cohérentes dans toute l'application. Si vous constatez dans d'autres projets que leurs spécifications d'annotation sont différentes de ce document, écrivez du code selon cette spécification et n'essayez pas d'introduire de nouvelles spécifications dans le système de spécifications établi.

2. Le contenu de l'annotation doit être précis et concis

Le contenu doit être simple, clair et précis dans son sens pour éviter toute ambiguïté. l'annotation. Mauvaise annotation non seulement elle n'est pas utile mais elle est nuisible.

Conditions d'annotation :

Annotation de base

(a) Classe (Interface) annotation

(b)

Constructeur annotation

(c) Annotation de méthode

(d) Global

Commentaires pour variables

(e) Commentaires pour les champs/

attributs

Remarque : faites des commentaires simples pour du code simple, et le contenu du commentaire ne doit pas dépasser 10 mots C'est tout . De plus, les méthodes getter et setter de l'objet

persistant ou de l'objet VO n'ont pas besoin d'être annotées. Veuillez vous référer à l'exemple ci-dessous pour le format de commentaire spécifique.

2. Des commentaires spéciaux sont requis

(a) Les algorithmes typiques doivent avoir des commentaires.

(b) Il doit y avoir des commentaires où le code n'est pas clair.

(c) Ajouter un commentaire indiquant la modification de la modification du code.

(d) Ajoutez des commentaires dans le code constitués de

boucles et de branches logiques.

(e) L'interface fournie pour les autres doit être commentée en détail.

Remarque : Il n'existe pas encore d'exemples de ce type de format de commentaire. Le format d'annotation spécifique est défini par vous-même et le contenu de l'annotation doit être précis et concis.

Format du commentaire :

1. Commentaire sur une seule ligne : "//……"

2. Bloquer commentaires : « /*

/**
* 类的描述
* @author Administrator
* @Time 2016-11-14:49:01
*
*/
public classTest extends Button {
 ……
}

*/ »

3. Commentaires du document : « /**

public class Test extends Button {
 /**
 * 构造方法 的描述
 * @param name
 * 按钮的上显示的文字
 */
 public Test(String name){
 ……
 }
}

*/ »

4. Syntaxe des balises de commentaire Javadoc

@author La description de la classe indique l'auteur qui a développé le module de ce type

@version La description de la classe indique la version du module de ce type
@see La description de la classe, les attributs et les méthodes fait référence au pilotage. C'est-à-dire des sujets connexes
@param Description de la méthode Description d'un certain paramètre dans la méthode
@
return Description de la méthode Description de la valeur de retour de la méthode @
exception Description de la méthode Décrit les exceptions que la méthode peut lever

Exemple de référence :

1. Annotation de classe (interface)

Par exemple :

public class Test extends Button {
 /**
 * 为按钮添加颜色
 *@param color
  按钮的颜色
*@return
*@exception (方法有异常的话加)
* @author Administrator
* @Time2012-11-20 15:02:29
 */
 public voidaddColor(String color){
 ……
 }
}

2. Méthode de constructeur Annotation Par exemple :

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. Annotation de méthode

par exemple

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. annotation

par exemple :

5. Commentaires sur le champ/attribut

Par exemple :

En fait, le cahier des charges est fixé par nous-mêmes, à condition que tout le monde dans l'équipe les suive de manière uniforme et les standardise, j'espère que cela sera utile aux amis qui n'ajoutent généralement pas de commentaires.

Ce qui précède est le contenu détaillé de. pour plus d'informations, suivez d'autres articles connexes sur le site Web de PHP en chinois!