Les partenaires publicitaires:

Comment créer javadoc en commentant

Javadoc est le standard de facto pour la génération de la documentation à partir du code source. Il est un outil pour créer des documents HTML à partir de commentaires spécialement formatés dans le code Java. Cela peut être utilisé pour générer l'interface de programmation d'application structurée (API) de la documentation automatiquement, donner quelques conseils à l'IDE ou l'attribution de packages, classes et méthodes. Essentiellement, il 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 javadoc de ligne de commande pour générer la documentation HTML, mais la plupart des environnements de développement intégrés Java (IDE) ont aussi cette intégré.

Instructions

  1. Créez commentaires Javadoc spéciaux. Pour désigner un commentaire javadoc, démarrer le commentaire avec /. commentaires Javadoc existent généralement en haut d'un fichier, avant que les classes et méthodes avant. Depuis il est conçu pour une documentation complète de l'API, il est pas rare de voir des fichiers avec plus de commentaires javadoc que code.""/
    Ceci est un commentaire javadoc. Il ne possède pas de javadoc méta-tags encore, mais il l'a fait déclencher l'analyseur de javadoc à jeter un oeil à ce commentaire.
    /""

  2. Ajouter API méta-tags (balises qui décrivent l'API elle-même), en commentant. balises de l'API sont les noms des paramètres, des descriptions, des profils d'exception, des descriptions de valeur de retour, les noms de méthodes et descriptions de méthodes. Beaucoup d'IDE intègrent ces données dans leurs conseils d'outils et autres aides, ainsi que cela est pour une utilisation sous forme de HTML ou un commentaire.



  3. Utilisez la description de la méthode. Cette méta-tag n'a pas de nom de tag: Il est tout simplement le commentaire qui vient avant les autres balises.""/ *
    Calcule la pente d'une ligne.
    * /""




  4. Incorporer descriptions de paramètres. Ceux-ci sont désignés par lesparam méta-tags, qui devraient être suivies par un nom de paramètre et description.""/ *
    Calcule la pente d'une ligne.

    param p1 Premier point qui décrit la ligne
    param Deuxième point p2 qui décrit la ligne
    /""

  5. Retour descriptions des valeurs. Ceci est indiqué par le méta-tagreturn 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 Deuxième point p2 qui décrit la ligne
    Pentereturn de la ligne comme un flotteur
    * /""

  6. Ajouter des balises d'attribution. Les balises attribuent le code pour un auteur spécifique.""/ *
    Calcule la pente d'une ligne.

    Author Jack Smith
    param p1 Premier point qui décrit la ligne
    param Deuxième point p2 qui décrit la ligne
    Pentereturn de la ligne comme un flotteur
    /""

  7. Générer la documentation HTML. Si vous n'êtes pas en utilisant un IDE ou vous voulez simplement 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 (généralement comme un joker).""docs de javadoc -d * .java""

Conseils & Avertissements

  • Lorsque vous utilisez un IDE, la documentation HTML est probablement fait automatiquement dans le cadre du processus de construction. Reportez-vous à la documentation de votre IDE pour le confirmer.
  • Les commentaires multi-lignes en Java commencent traditionnellement avec /
  • , mais le caractère astérisque supplémentaire dans Javadoc signale la javadoc analyseur de commencer à chercher javadoc méta-tags.
» » » » Comment créer javadoc en commentant