{"id":55,"date":"2021-05-29T13:47:15","date_gmt":"2021-05-29T13:47:15","guid":{"rendered":"https:\/\/www.louismarchand.me\/?page_id=55"},"modified":"2023-02-01T19:23:04","modified_gmt":"2023-02-01T19:23:04","slug":"javadoc","status":"publish","type":"page","link":"https:\/\/www.louismarchand.me\/index.php\/javadoc\/","title":{"rendered":"Javadoc"},"content":{"rendered":"

Introduction<\/h2>\n

La documentation de code est un des aspects les plus importants de la programmation. \u00c7a permet entre autres de facilement comprendre la m\u00e9canique de code, augmente la facilit\u00e9 de navigation dans le projet, diminue le risque de bogues, acc\u00e9l\u00e8re le d\u00e9bogage des programmes et facilite l’entretient long terme des solutions informatiques.<\/p>\n

Java fournit un standard et des outils qui permettent de faciliter la documentation de code et de g\u00e9n\u00e9rer des documents de documentation.<\/p>\n

Les documentations sont annot\u00e9es sous la forme de commentaire d\u00e9butant avec une ligne:<\/p>\n

\/**<\/pre>\n
et se terminant avec la ligne:<\/p>\n
*\/<\/pre>\n
Chaque ligne d\u00e9bute par le caract\u00e8re \u00ab\u00a0*\u00a0\u00bb align\u00e9 avec le premier caract\u00e8re \u00ab\u00a0*\u00a0\u00bb de la premi\u00e8re ligne de la documentation. Par exemple:<\/p>\n
\n
\/**<\/span>\r\n * Ceci est une documentation de code.<\/span>\r\n *\/<\/span>\r\n<\/pre>\n<\/div>\n
La premi\u00e8re ligne \u00e0 l’int\u00e9rieur de l’encadr\u00e9 de documentation correspond toujours \u00e0 la description courte de la documentation. On peut ensuite mettre une description longue en s\u00e9parant celle-ci de la description courte par une ligne vide. Par exemple:<\/p>\n
\n
\/**<\/span>\r\n * Ceci est la description courte qui doit \u00eatre sur une seule ligne.<\/span>\r\n *<\/span>\r\n * Et ceci est la description longue de la documentation. Il est \u00e0 noter qu'il<\/span>\r\n * est possible de mettre cette derni\u00e8re sur plusieurs lignes.<\/span>\r\n * <p><\/span>\r\n * Il est \u00e9galement possible de mettre des paragraphes \u00e0 la description longue,<\/span>\r\n * ou m\u00eame des:<\/span>\r\n * <ul><\/span>\r\n * <li>Liste<\/span>\r\n * <li>d'item<\/span>\r\n * <\/ul><\/span>\r\n * en utilisant des notations similiaires \u00e0 la syntaxe Web.<\/span>\r\n *\/<\/span>\r\n<\/pre>\n<\/div>\n
On peut voir qu’il est possible de mettre quelques \u00e9l\u00e9ments de mise en page qui sera utile lorsque la documentation Web sera g\u00e9n\u00e9r\u00e9e.<\/p>\n
Javadoc fonctionne \u00e9galement avec un syst\u00e8me d’\u00e9tiquette (ou tag) afin de sp\u00e9cifier des \u00e9l\u00e9ments pr\u00e9cis dans notre documentation. Les \u00e9tiquettes d\u00e9butent par \u00ab\u00a0@\u00a0\u00bb. Voici les principales \u00e9tiquettes:<\/p>\n
    \n
  • \n
      \n
    • \n
        \n
      • \n
          \n
        • \u00ab\u00a0@author\u00a0\u00bb: Sp\u00e9c\u00e9fie l’auteur de la classe;<\/li>\n
        • \u00ab\u00a0@version\u00a0\u00bb: Sp\u00e9cifie la version de la classe et la date de derni\u00e8re modification;<\/li>\n
        • \u00ab\u00a0@since\u00a0\u00bb: Sp\u00e9cifie la premi\u00e8re version de Java que la classe est consid\u00e9r\u00e9e comme \u00e9tant fonctionnelle;<\/li>\n
        • \u00ab\u00a0{@link r\u00e9f\u00e9rence}\u00a0\u00bb: Permet de mettre une r\u00e9f\u00e9rence dans une description (courte ou longue) vers une classe, m\u00e9thode, attribut ou r\u00e9f\u00e9rence externe;<\/li>\n
        • \u00ab\u00a0@param\u00a0\u00bb: Sp\u00e9cifie un argument d’une routine;<\/li>\n
        • \u00ab\u00a0@return\u00a0\u00bb: Sp\u00e9ficie la valeur de retour d’une routine<\/li>\n
        • \u00ab\u00a0@throws\u00a0\u00bb ou \u00ab\u00a0@exception\u00a0\u00bb: Sp\u00e9cifie un exception que la routine peut lancer et dans quel contexte ce dernier se lance;<\/li>\n
        • \u00ab\u00a0@deprecated\u00a0\u00bb: Indique qu’une classe, m\u00e9thode ou attribut a \u00e9t\u00e9 remplac\u00e9 et ne doit plus \u00eatre utilis\u00e9;<\/li>\n
        • \u00ab\u00a0@see\u00a0\u00bb: Sp\u00e9cifie une r\u00e9f\u00e9rence pertinente\n