Javadoc

Le Javadoc est un outil de logiciel de Sun Microsystems pour produire de la documentation du api dans le format de HTML du code source de Java .

Javadoc est le standard industriel pour documenter des classes de Java. La plupart de IDEs produira automatiquement de HTML de Javadoc.

Javadoc fournit également un api pour créer le Doclets et le Taglets , qui te permet d'analyser la structure d'une application de Java. C'est comment le JDiff peut produire des rapports de ce qu'a changé entre deux versions d'un api.

Exemple

Un exemple de l'utilisation Javadoc pour documenter une méthode suit. Noter que l'espacement et la quantité de caractères dans cet exemple sont comme état de conventions. /** * Valide un mouvement d'échecs. Utilisation {#doMove de @link (international, international, international, international)} pour déplacer un morceau. * * dossier theFromFile de @param dont un morceau est déplacé * grade de theFromRank de @param dont un morceau est déplacé * dossier theToFile de @param auquel un morceau est déplacé * grade de theToRank de @param auquel un morceau est déplacé * @return vrai si le mouvement d'échecs est valide, autrement faux * daine de John de @author * isValidMove booléen (international theFromFile, theFromRank d'international, international theToFile, theToRank d'international) { … } /** * Déplacer une pièce d'échecs.RoundingMode * doMove booléen (international theFromFile, theFromRank d'international, international theToFile, theToRank d'international) { … }

Les étiquettes et comment écrire le Doc. de Java commente

Descendre au lien au-dessous de la manière environ moitié que la page il y a une liste d'étiquettes que vous pouvez employer avec dedans un commentaire de javadoc. Expositions de cet emplacement également vous comment écrire un javadoc comment.
Étiquettes de JavaDoc et comment écrire des commentaires

Voir également


liste des générateurs de documentation

.

Random links:Lindley, New York | Chamaeleo | L'atmosphère d'Adobe | Grain d'Aleph | Javadoc