Critères de commentaire personnel [édition Java]

Au cas où l'on vous demanderait: "Quels critères utilisez-vous pour commenter?" Je l'ai écrit en 30 minutes environ, donc je pense qu'il y a beaucoup d'omissions, mais ça ressemble à ça.

Javadoc Fondamentalement mis. Private a une priorité légèrement inférieure, mais elle doit être ajoutée autant que possible, surtout s'il s'agit d'une méthode. Utilisez de nombreux mécanismes (tels que le retour) préparés du côté Javadoc, et n'utilisez jamais de choses semblables à des balises.

Q. Javadoc privé ne signifie pas la génération de documents. Es-tu stupide? R. Il est généré automatiquement et j'ai un indice. Et je vais prendre quelques conseils complémentaires dans Javadoc. Ce n'est qu'après avoir donné la sagesse à toute l'humanité que l'on peut dire que tous les noms de variables peuvent être gérés.

Normal Il est attaché selon les critères suivants.

Rewrite Réécrivez ou supprimez des commentaires tels que les suivants si possible Lorsque les mots «** get » et « set **» apparaissent, ils sont généralement exclus.

[^ 1]: A tendance à être à moitié chiennes. Angle de lapin court. [^ 2]: Puisque le contenu est contenu, il a tendance à être à nouveau long. Vous devez préparer le matériel et l'écrire là-bas. [^ 3]: Validateur Hibernate. [^ 4]: validation de l'adresse e-mail. [^ 5]: Que pensez-vous vraiment du fait que "serialVersionUID" soit écrit en serialVersionUID en particulier? Pensez-vous à quelque chose? [^ 6]: Je me demande si j'ai lu les spécifications Javadoc. Je suppose que je n'ai pas pu le lire. [^ 7]: Heureusement, "il a été écrasé même si des choses importantes ont été écrites côté interface" ne se produit pas de façon inattendue. C'est généralement une copie.

Recommended Posts

Critères de commentaire personnel [édition Java]
Commentaire sur la documentation java
Java statique [Résumé personnel]
Résumé personnel sur Java
Mises à jour des notes personnelles en vigueur de Java Third Edition 2nd Edition
Guide de développement Java moderne (édition 2018)
Nombre de commentaires Java (matériel VBA)
Java HashMap, entrySet [Mémo personnel]
JAVA (Première étape: édition Git Bush)
Mémo personnel: métaprogrammation avec réflexion Java
Efficacité de Java 3rd Edition Chapitre 5 Génériques
Résumé de l'algorithme AtCoder 400 points (édition Java)
Méthodes efficaces du chapitre 8 de Java 3rd Edition