|
Javadoc est le standard de facto pour la génération de la documentation à partir du code source. C'est un outil pour créer des documents HTML de commentaires spécialement formatés dans le code Java. Ceci peut être utilisé pour générer la documentation de l'interface de programmation d'application structurée (API) automatiquement , donner quelques conseils à l'IDE ou l'attribution de packages, classes et méthodes . Essentiellement, c'est une façon de se prononcer sur la description des paramètres , qui a écrit quoi, et qui blâmer si elle se casse . Java est livré avec le programme en ligne de commande javadoc pour générer la documentation HTML, mais les environnements de développement intégrés (IDE Java le plus ) ont également intégré cette . Instructions
1 Créer commentaires javadoc spéciales. Pour désigner un commentaire javadoc , démarrez le commentaire avec /** . Les commentaires Javadoc existent généralement en haut d'un fichier, avant que les classes et méthodes avant . Depuis qu'il est conçu pour la documentation de l'API complète , il n'est pas rare de voir des fichiers avec d'autres commentaires javadoc que le code . "" /*** Ceci est un commentaire javadoc . Il n'a pas de javadoc méta-tags encore, mais il l'a fait déclencher l'analyseur de javadoc à jeter un oeil à ce commentaire. * /""
2 Ajoutez API méta -tags ( balises qui décrivent l'API elle-même ) au moment de commenter . Balises API sont les noms des paramètres , des descriptions , des profils d'exception , des descriptions de valeur de retour, les noms de méthode et les descriptions de méthode. Beaucoup d'IDE intègrent ces données dans leurs infobulles et autres aides , ainsi que cela est pour une utilisation en HTML ou sous forme de commentaire.
3 Utilisez la description de la méthode. Cette méta -tag n'a pas de nom de tag: C'est tout simplement le commentaire qui vient avant les autres balises "" /*** Calcule la pente de la droite . . * /""
4 Intégrer descriptions de paramètres. Ceux-ci sont désignés par le @ param méta-tags , qui devrait être suivi par un nom de paramètre et description " . " /*** Calcule la pente d'une ligne . ** @ Param p1 Premier point qui décrit la ligne * @ param p2 Deuxième point qui décrit la ligne * /""
5 descriptions des valeurs de retour . Ceci est indiqué par le signe @ retour méta -tag et devrait être suivie par une description de la valeur de retour " . " /*** Calcule la pente d'une ligne . ** @ Param p1 Premier point qui décrit la ligne * @ param p2 Deuxième point qui décrit la ligne * @ return Pente de la droite comme un float * /""
6 Ajouter vos tags d'attribution. Les balises attribuent le code à un auteur spécifique. "" /*** Calcule la pente d'une ligne . ** @ Author Jack Smith * @ param p1 Premier point qui décrit la ligne * @ param p2 Deuxième point qui décrit la ligne * @ return Pente de la droite comme un float * /""
7 générer la documentation HTML. Si vous n'utilisez pas un IDE ou vous voulez juste de le faire manuellement , vous pouvez exécuter le programme en ligne de commande javadoc du répertoire de votre projet . Spécifiez le répertoire de sortie avec le commutateur-d et transmettre une liste de fichiers. Java ( habituellement comme un joker ) "." Javadoc -d docs * . Java " "
< br >
|
