Looking for java Answers? Try Ask4KnowledgeBase
Looking for java Keywords? Try Ask4Keywords

Java LanguageDocumentation du code Java


Introduction

La documentation du code Java est souvent générée à l'aide de javadoc . Javadoc a été créé par Sun Microsystems dans le but de générer une documentation API au format HTML à partir du code source Java. L'utilisation du format HTML permet de créer des liens hypertexte entre des documents associés.

Syntaxe

  • / ** - début de JavaDoc sur une classe, un champ, une méthode ou un package
  • @author // Pour nommer l'auteur de la classe, de l'interface ou de l'énumération. C'est requis.
  • @version // La version de cette classe, interface ou enum. C'est requis. Vous pouvez utiliser des macros telles que% I% ou% G% pour votre logiciel de contrôle de code source pour remplir la vérification.
  • @param // Affiche les arguments (paramètres) d'une méthode ou d'un constructeur. Spécifiez une balise @param pour chaque paramètre.
  • @return // Affiche les types de retour pour les méthodes non vides.
  • @exception // Indique quelles exceptions peuvent être émises par la méthode ou le constructeur. Les exceptions qui DOIVENT être prises doivent être listées ici. Si vous le souhaitez, vous pouvez également inclure ceux qui n'ont pas besoin d'être interceptés, comme ArrayIndexOutOfBoundsException. Spécifiez une exception @ pour chaque exception pouvant être levée.
  • @throws // Identique à @exception.
  • @see // Liens vers une méthode, un champ, une classe ou un package. Utiliser sous la forme de package.Class # quelque chose.
  • @since // Lorsque cette méthode, champ ou classe a été ajouté. Par exemple, JDK-8 pour une classe comme java.util.Optional <T> .
  • @serial, @serialField, @serialData // Utilisé pour afficher le serialVersionUID.
  • @deprecated // Pour marquer une classe, une méthode ou un champ comme étant obsolète. Par exemple, un serait java.io.StringBufferInputStream . Voir une liste complète des classes obsolètes existantes ici .
  • {@link} // Similaire à @see, mais peut être utilisé avec du texte personnalisé: {@link #setDefaultCloseOperation (int closeOperation) voir JFrame # setDefaultCloseOperation pour plus d'informations}.
  • {@linkplain} // Similaire à {@link}, mais sans la police de code.
  • {@code} // Pour le code littéral, tel que les balises HTML. Par exemple: {@code <html> </ html>}. Cependant, cela utilisera une police à espacement fixe. Pour obtenir le même résultat sans la police monospace, utilisez {@literal}.
  • {@literal} // Identique à {@code}, mais sans la police monospace.
  • {@value} // Affiche la valeur d'un champ statique: la valeur de JFrame # EXIT_ON_CLOSE est {@value}. Vous pouvez également créer un lien vers un champ donné: Utilise le nom de l'application {@value AppConstants # APP_NAME}.
  • {@docRoot} // Le dossier racine du HTML JavaDoc relatif au fichier en cours. Exemple: <a href="{@docRoot}/credits.html"> Crédits </a>.
  • HTML est autorisé: <code> "Salut les cookies" .substring (3) </ code>.
  • * / - fin de la déclaration JavaDoc

Remarques

Javadoc est un outil fourni avec le JDK qui permet de convertir les commentaires dans le code en une documentation HTML. La spécification de l'API Java a été générée à l'aide de Javadoc. La même chose est vraie pour une grande partie de la documentation des bibliothèques tierces.

Documentation du code Java Exemples Liés