Comment documenter des packages en Java?

Question

Comment documenter des packages en Java?

Demandé el 8 de Mars, 2009: Quand la question a-t-elle été
15321 affichage: Nombre de visites la question a
4 Réponses: Nombre de réponses aux questions
Résolu: Situation réelle de la question

Dans les API Java, je peux voir les commentaires Javadoc pour les packages.

Comment / où placer les commentaires Javadoc pour documenter un paquet?

Demandé el 8 de Mars, 2009 par jjnguy

Answer 1

4 Réponses

Answer 2

279voto

Gareth Davis Points 16190

À partir de la version 1.5, vous pouvez définir un fichier package-info.java et fournir un commentaire de style javadoc standard pour un package:

com / foo / package-info.java:

 /**
 * com.foo is a group of bar utils for operating on foo things.
 */
package com.foo;

//rest of the file is empty

Spécification de langue pour les packages

Répondu el 8 de Mars, 2009 par Gareth Davis (16190 Points )

Answer 3

55voto

sleske Points 29978

Jusqu'à Java 1.4, vous deviez fournir un fichier HTML package.html, comme décrit dans les autres réponses.

Depuis Java 1.5, vous pouvez également fournir un package-info.java, qui contient un commentaire Javadoc normal (pas de HTML). Ce dernier est préférable, car il vous offre des fonctionnalités supplémentaires (notamment des annotations de paquets).

Détails: Documents de Sun pour javadoc

Répondu el 8 de Mars, 2009 par sleske (29978 Points )

Answer 4

3voto

oxbow_lakes Points 70013

Avec un fichier package.html au niveau du package (c'est-à-dire dans le répertoire de ce package). Cela devrait être une forme complète HTML fichier, avec le <html> étiquette définie dans ce

Répondu el 8 de Mars, 2009 par oxbow_lakes (70013 Points )

Answer 5

2voto

Glenn Points 3787

Je crois que c'est la réponse précise à votre question.

Répondu el 8 de Mars, 2009 par Glenn (3787 Points )

Comment documenter des packages en Java?

Réponses

Questions en vedette

Top Tags

Prograide.com

Powered by:

Comment documenter des packages en Java?

Réponses

Questions connexes

Questions en vedette

Top Tags

Dans notre réseau

Prograide.com

Powered by: