2 réponses
Salut
voici la syntaxe de rédaction des Javadocs :
Les javadocs sont des lignes de commentaires placé dans le code avec la syntaxe suivante
/*
* Description de la classe en language naturel
*
* @tag
* @tag
*/
code Java auquel s'applique les commentaires précédants
Exécution :
Le programme javadoc lit les fichiers java que vous lui spécifier, analyse le code et les commentaires qu'il contient et génère les fichiers html javadocs. La commande à utiliser pour les créer est :
javadocs fichiers.java
Liste des Tags :
Tag auteur, pour une classe ou une interface
@author Prénom Nom
Tag de version, pour une classe
@version 1.37, 26 Jun 1996
Tags de renvois de valeur pour une méthode
@return Objet retourné Détail sur l'objet retourné
@exception Exception renvoyé Détails de l'exception, cas où elle renvoyée.
Tag de référence, pour renvoyer le lecteur aux classes ou méthodes dont la compréhension est nécessaire pour celle de la classe présente. Il peut s'appliquer à une classe ou à une méthode.
@see java.lang.String
@see String
@see java.io.InputStream;
@see java.lang.Object#wait(int)
@see <a href="spec.html">Java Spec</a>
Les éléments d'une classe sont séparés de la classe par un #.
Du code html peut être inséré directement puisque le code final est de l'html.
Tag pour les paramètres des méthodes
@param nom Détail sur le paramètre, explications nécessaires.
Tag pour connaître la date d'ajout d'une fonction
@since 0.1
Ressources :
http://java.sun.com/j2se/javadoc/writingdoccomments/index.html
How to pour écrire des commentaires en JavaDoc
http://java.sun.com/docs/books/jls/first_edition/html/18.doc.html
Description de certains tags en détail, exemples de classes des API Java.
Kavoun
voici la syntaxe de rédaction des Javadocs :
Les javadocs sont des lignes de commentaires placé dans le code avec la syntaxe suivante
/*
* Description de la classe en language naturel
*
* @tag
* @tag
*/
code Java auquel s'applique les commentaires précédants
Exécution :
Le programme javadoc lit les fichiers java que vous lui spécifier, analyse le code et les commentaires qu'il contient et génère les fichiers html javadocs. La commande à utiliser pour les créer est :
javadocs fichiers.java
Liste des Tags :
Tag auteur, pour une classe ou une interface
@author Prénom Nom
Tag de version, pour une classe
@version 1.37, 26 Jun 1996
Tags de renvois de valeur pour une méthode
@return Objet retourné Détail sur l'objet retourné
@exception Exception renvoyé Détails de l'exception, cas où elle renvoyée.
Tag de référence, pour renvoyer le lecteur aux classes ou méthodes dont la compréhension est nécessaire pour celle de la classe présente. Il peut s'appliquer à une classe ou à une méthode.
@see java.lang.String
@see String
@see java.io.InputStream;
@see java.lang.Object#wait(int)
@see <a href="spec.html">Java Spec</a>
Les éléments d'une classe sont séparés de la classe par un #.
Du code html peut être inséré directement puisque le code final est de l'html.
Tag pour les paramètres des méthodes
@param nom Détail sur le paramètre, explications nécessaires.
Tag pour connaître la date d'ajout d'une fonction
@since 0.1
Ressources :
http://java.sun.com/j2se/javadoc/writingdoccomments/index.html
How to pour écrire des commentaires en JavaDoc
http://java.sun.com/docs/books/jls/first_edition/html/18.doc.html
Description de certains tags en détail, exemples de classes des API Java.
Kavoun
salutS.V.P aidez moi c'est tres important
* comment générer automatiqument des page HTML avec jbuilder4
* j'ai reussi a spécifier les attributs javadoc dans mon code source , mais je ne sais pas comment utiliser l'onglet DOC de jbuilder4
* on cliquant sur l'anglet DOC de l'editeur de code : une zone de saisie est afficher mais je ne sais pas comment la remplir
merci
* comment générer automatiqument des page HTML avec jbuilder4
* j'ai reussi a spécifier les attributs javadoc dans mon code source , mais je ne sais pas comment utiliser l'onglet DOC de jbuilder4
* on cliquant sur l'anglet DOC de l'editeur de code : une zone de saisie est afficher mais je ne sais pas comment la remplir
merci
