Comment puis-je documenter les paquets en Java?
dans L'API Java, je peux voir les commentaires Javadoc pour les paquets.
comment / où puis-je placer les commentaires Javadoc pour documenter un paquet?
3 réponses
à partir de 1.5, vous pouvez définir un fichier package-info.java
et fournir un commentaire de style javadoc standard pour un paquet:
com/foo/paquet-info.java:
/**
* com.foo is a group of bar utils for operating on foo things.
*/
package com.foo;
//rest of the file is empty
Jusqu'à Java 1.4, vous deviez fournir un paquet de fichier HTML.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 régulier (pas de HTML). Ce dernier est préférable, car il vous donne quelques fonctionnalités supplémentaires (notamment des annotations de paquets).
détails: Soleil de la documentation javadoc
avec un fichier package.html
au niveau du paquet (c'est-à-dire dans le répertoire de ce paquet). Il doit s'agir d'un fichier HTML
entièrement formé, avec la balise <html>
définie dans le fichier