Mais il faut les utiliser seulement pour des choses simples. Voici les principaux :La première phrase Javadoc de la classe doit être une courte description de la classe.Ce conseil vaut aussi pour les méthodes, variables, etc.Utilisez la troisième personne pour commenter une méthode.Détaillez le fonctionnement (algo) des méthodes si besoin.Les tags @param et @return doivent être systématiquement indiqués (sauf méthodes sans paramètres ou méthodes void).Eh oui ! Mais par analogie, c'est aussi la documentation générée par cet outil.Cet outil permet, en inspectant le code Java des classes, de produire une documentation très complète de votre code web.L'outil Javadoc est inclus dans tous les JDK (ou SDK) de Java.

<< R 0 Books. /CS Provides an introduction to Java Management Extension technology. <> 1

Describes how to migrate Oracle JRockit to Java HotSpot VM. /Annots <>

Et je vous assure que je ne suis pas le seul à penser ça. Summarizes internationalization APIs and features of Java SE. Similarly, the line which preceeds // is Java single-line comment. 0 0 Très heureux de voir que nos cours vous plaisent, déjà 5 pages lues aujourd'hui !

Java SE documentation. >>

Ensuite, vous pouvez sélectionner les différents packages que vous voulez documenter, ainsi que la visibilité de la documentation. Vous pouvez continuer la lecture de nos cours en devenant un membre de la communauté d'OpenClassrooms.

2

Pour plus d'informations, référez-vous au guide de style de SUN (voir en bas de ce tuto).Le tag @param sert à renseigner le ou les paramètres de la méthode. /Type

Describes the process for installing JDK 13 and JRE 13 on your Windows, macOS, and Linux platforms. Derrière ce tag, il faut noter un numéro de version de la classe.Le tag @deprecated doit décrire la version depuis laquelle cette méthode / classe est dépréciée. Java ME Embedded is designed for resource-constrained devices like wireless modules for M2M, industrial control, smart-grid infrastructure, environmental sensors and tracking, and more.

/Catalog Il devient très facile de naviguer dans la documentation, au fil de la lecture.Et puis comme ça, vous ne serez pas perdus pour mettre en forme vos commentaires ;)Voici deux exemples de documentation générée par l'outil Javadoc.

Java ME (Java Platform, Micro Edition): J2ME pour les applications embarquées, PDA, téléphones, etc.

<< <<

/Filter

endobj Describes the new and updated language features in Java SE 9 and subsequent releases.

Describes the utilities provided with Java Platform, Standard Edition (Java SE) for monitoring and managing the performance of a Java Virtual Machine and the Java applications that are running in it. 13 0 obj Je vous ai dit au début ce tuto que l'on pouvait utiliser le HTML dans les commentaires Javadoc. Java EE (Java Platform, Enterprise Edition): Java EE 6 pour développer et déployer des applications serveur, Web services, etc. Intéressant, non ? :ange:S'il n'y a pas d'erreurs, votre documentation est prête.

Mais par analogie, c'est aussi la documentation générée par cet outil. 15 9 0 obj

0

Si vous passez le pointeur de votre souris sur le nom d'une classe ou d'une méthode, une petite fenêtre d'information s'accroche sous le pointeur de votre souris, pour vous montrer la documentation correspondante.Mieux, si vous voulez garder cette information "sous le coude", vous pouvez l'afficher dans la vue "Doc" en bas de l'écran, et continuer à travailler sur votre code. Remplissez le champ "Commande Javadoc" si ce n'est pas déjà fait. 0

Mais aussi ce qu'il faut utiliser à la place.Maintenant que vous connaissez tous les tags, voyons comment les mettre en forme et les enrichir.

endobj obj

stream

0 "En effet, il existe un grand nombre de Doclets, qui permettent d'exporter votre JavaDoc en différents formats, tels que PDF, XML, DocBook, LaTeX, etc. 0 <>

4 /FlateDecode <>/ExtGState<>/XObject<>/ProcSet[/PDF/Text/ImageB/ImageC/ImageI] >>/MediaBox[ 0 0 595.32 841.92] /Contents 4 0 R/Group<>/Tabs/S/StructParents 0>> The documentation for JDK 14 includes developer guides, API documentation, and release notes.

10 Pire encore, si une personne lit dans votre code que vous utilisez une fonction, il est impossible pour lui d'en savoir plus sur cette fonction, sans avoir à chercher sur google par exemple... Imaginez le temps perdu ! endobj

0 Mais ils ne sont pas pris en compte par l'outil Javadoc.

;)Objectivement, il n'y a rien de plus simple. Vous devrez éditer chaque page de la documentation concernée par ces changements...Vous avez bien compris l'intérêt de documenter son code. 0 Tous les tags Javadoc sont inclus dans cet exemple. Tout d'abord, cela permet de mieux comprendre ce que l'on a écrit.

/Pages

HTML PDF.

Helps troubleshoot issues that might occur with Java Client applications created on the Java Platform, Standard Edition (Java SE) and Java HotSpot VM.

Helps to identify potential issues and provides suggestions for migrating your existing Java application from JDK 8 to the latest JDK. Mais si quelqu'un veut avoir une vue globale de votre code, il doit quand même le lire intégralement. Et les conventions d'écriture de SUN sont globalement respectées.

>>

17 11 0 obj

/Resources Provides information about the Java core libraries.

<< N'essayez pas d'en faire trop, ce n'est pas le but.

Vous utilisez un navigateur obsolète, veuillez le Ce tuto présente l'outil Javadoc de Sun, qui permet de générer les documentations d'un code Java.Ca sert à quoi de commenter son code ? Following is a simple example where the lines inside /*…. 0 Mais surtout, cela facilitera le travail de ceux qui voudraient comprendre, utiliser, voire maintenir votre travail. :pIl existe une grande quantité de conseils pour la mise en page des commentaires Javadoc.