Introduction :
Nous savons que javadoc est intégré dans le JDK, donc suivre la spécification javadoc est définitivement l'orthodoxie de l'annotation java. Avec l'aide de javadoc, c'est. est nécessaire pour générer la documentation API Très pratique.
(Partage de vidéos d'apprentissage : tutoriel vidéo Java)
1. Que sont les commentaires
Les commentaires sont à faire ? coder plus Il est lisible et réduit le coût de communication du travail d'équipe. Dans une équipe, si votre code est plus clair, plus lisible et plus standardisé, alors la promotion et l'augmentation de salaire seront définitivement les vôtres, car vous pourrez être compatible avec plus de personnes.
J'ai entendu un dicton il y a quelque temps : si vous êtes le seul à pouvoir comprendre votre code, alors vous êtes la personne indispensable. La personne qui a dit cela est stupide. Lui seul peut comprendre le code qu'il écrit. Personne ne veut le voir. Il vit comme un petit-fils.
2. Touches de raccourci de commentaire couramment utilisées
Commenter une ligne : //Je suis le contenu de la ligne
Touche de raccourci : ctrl+/ Opération inverse : ctrl+/Commenter un bloc : / *Je suis le contenu du bloc* /
Touche de raccourci : ctrl+shift+/ Opération inverse : ctrl+shift+javadoc Commentaires reconnaissables :
1 2 3 4 5 |
|
3. Spécification Javadoc
Suivez la spécification javadoc, nous pouvons utiliser la commande javadoc pour générer des documents API très intuitifs et faciles à lire, ce qui est très pratique.
Les commentaires que nous apparaissons dans le programme peuvent être consciemment divisés en deux types, l'un est constitué de commentaires simples, pour notre propre lecture, et l'autre est constitué de commentaires conformes à la spécification javadoc, dans le but de générer des commentaires faciles à lire. documents.
Lisez attentivement le document API généré. Il y a trois parties que nous devons expliquer, comme le montre la figure :
Le contenu dans la case rouge ci-dessus est les commentaires que j'ai ajoutés. C'est un simple cours Hello. Le code source est le suivant. Si vous êtes intéressé, vous pouvez l'essayer vous-même :
.1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 |
|
Il y a plusieurs points à souligner :
Si vous souhaitez que l'auteur et la version apparaissent dans le document API, vous ne devez pas seulement ajouter @author et @version dans les commentaires du programme ( il est à noter que l'annotation de @author à plusieurs endroits dans le programme ne sera affichée qu'une seule fois dans le document final (je recommande de ne commenter qu'une seule fois), et de le signaler également dans la commande dos lors de la compilation :
dossier javadoc -d. -version -author Hello.java
où -d dossier signifie que vous placez le document API généré (en fait de nombreuses pages Web composées) est placé dans un dossier dossier Bien sûr, le dossier peut également être un chemin
1 2 3 4 5 6 7 8 9 10 11 12 |
|
Ce que nous pouvons contrôler dans le programme, c'est la composition des commentaires, mais cette composition n'est pas reconnue par Javadoc qui trouve une ligne de commentaires et uniquement. supprime * et les espaces. , je viens de le passer et j'ai remarqué que le document généré est de type HTML, donc tant que vous commentez la syntaxe HTML dans le programme, vous pouvez modifier le format du document API. trop difficile, car nous utilisons simplement une syntaxe HTML simple, comme les paragraphes
, la nouvelle ligne
, cela suffit, après tout, les commentaires ne seront pas très longs.
Écrivez-la s'il y a une valeur de retour S'il n'y a pas de valeur de retour. , vous n'avez pas besoin de l'écrire. Si vous l'écrivez, ce sera le cas. Signalement des erreurs
Je pense que vous connaissez ces deux images. La première est une invite qui peut apparaître lorsque le curseur reste lors de l'écriture d'un programme. Si vous écrivez des commentaires selon la spécification javadoc, alors vous l'avez écrit vous-même. Le programme apparaît également avec ces invites extrêmement utiles. La seconde est la description détaillée du champ out dans la classe String dans le document API Java8. C'est également le mérite de @see. Vous avez écrit @see, et il existe une telle annotation dans votre propre document API de projet.
Recommandations associées : Tutoriel d'introduction à Java
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!