Il est très important pour les développeurs de programme d'attacher des commentaires au code. Avec le développement de la technologie, les programmeurs doivent être tenus d'écrire des commentaires de code pendant le développement du projet, ce qui est propice à l'écriture et à l'utilisation ultérieures du code.
Exigences de base:
1. Formulaire de commentaire unifié
Tout au long de l'application, utilisez des styles avec une ponctuation et une structure cohérentes pour construire des annotations. Si vous constatez que leurs spécifications d'annotation sont différentes de ce document dans d'autres projets, écrivez du code en fonction de cette spécification et n'essayez pas d'introduire de nouvelles spécifications dans le système de spécification établi.
2. Le contenu du commentaire est exact et concis
Le contenu doit être simple, clair et précis, et la signification doit être empêchée de l'ambiguïté des commentaires. Les commentaires incorrects sont non seulement inutiles mais aussi nocifs.
3. Commentaires de base (doivent être ajoutés)
(a) Commentaires pour la classe (interface)
(b) Commentaire du constructeur
(c) Commentaires sur les méthodes
(d) Commentaires des variables globales
(e) Remarques pour les champs / attributs: le code simple fait des commentaires simples, le contenu du commentaire ne dépasse pas 10 mots, et en outre, les objets persistants ou
Les méthodes Getter et Setter des objets VO n'ont pas besoin d'être commentées. Pour des formats de commentaires spécifiques, veuillez vous référer aux exemples suivants.
4. Des commentaires spéciaux doivent être ajoutés (doivent être ajoutés)
(a) Les algorithmes typiques doivent être commentés.
(b) Les commentaires doivent être faits dans un code peu clair.
(c) Ajouter un commentaire à la marque de modification à la modification du code.
(d) Commentaire dans le code composé de boucles et de branches logiques.
(e) Les interfaces fournies à d'autres doivent être commentées en détail.
Remarque: il n'y a pas d'exemples pour ce type de format de commentaire. Le format d'annotation spécifique est défini par vous-même et le contenu d'annotation est nécessaire pour être précis et concis.
5. Format de commentaire:
1) Commentaire en une seule ligne: "// ..."
2) Block Commentaire: "/ *… * /"
3) Document Commentaires: "/ **… * /"
4) Syntaxe de la balise de commentaire Javadoc
@author La description de la classe indique que l'auteur qui a développé le module de la classe
@version La description de la classe indique la version du module de la classe
@see référence tournez-vous à la description des classes, des propriétés et des méthodes, c'est-à-dire des sujets connexes
@param Description de la méthode Description d'un paramètre dans une méthode
@return Description de la méthode Description de la valeur de retour de la méthode
@Exception Description de la méthode Description des exceptions qui peuvent être lancées par la méthode
6. Exemple:
/ ** Créez une classe d'outils pour manipuler les tableaux, qui contient cette fonction commune pour les tableaux de fonctionnement: la plus valeur. @author zhang san @ version v. * / classe publique Arraytool {/ ** Obtenez la valeur maximale du tableau de mise en forme @param arr recevez un tableau d'éléments de type int @return la valeur d'élément maximale du tableau * / public int getmax (int arr) {int max =; retourner max; }}Entrez la commande comme indiqué ci-dessous:
Puis vérifier dans le répertoire suivant et enfin cliquer sur index.html:
Le contenu ci-dessus partage les spécifications de commentaires du code Java avec vous, en espérant que cela vous sera utile.