J'utilise CheckStyle , FindBugs et PMD pour valider mon code Java. J'ai corrigé presque tous les bogues détectés par ces outils.
Je n'arrive pas à comprendre comment écrire un "commentaire de paquet" qui est un bogue détecté par checkstyle. J'ai parcouru la documentation de CheckStyle, mais je ne la comprends pas.
Quelqu'un pourrait-il m'aider à écrire un commentaire de niveau paquet en Java ?
Les commentaires javadoc au niveau du paquet sont placés dans un fichier nommé package-info.java dans le répertoire du paquet. Il contient le commentaire et une déclaration de paquetage :
/**
* Provides the classes necessary to create an applet and the classes an applet uses
* to communicate with its applet context.
* <p>
* The applet framework involves two entities:
* the applet and the applet context. An applet is an embeddable window (see the
* {@link java.awt.Panel} class) with a few extra methods that the applet context
* can use to initialize, start, and stop the applet.
*
* @since 1.0
* @see java.awt
*/
package java.lang.applet;Ceci est documenté ici : Fichiers de commentaires sur les paquets
Intéressant. La page sur l'écriture de commentaires pour Javadoc (voir ma réponse) ne mentionne même pas cela.
@Thomas : garder une documentation qui se chevauche et qui est constamment à jour est une vraie plaie.
En effet, c'est le cas. J'aurais soupçonné que Sun (et maintenant Oracle) aurait fait un meilleur travail de maintenance de la documentation. D'autant plus que je fais du développement Java depuis plus de 5 ans maintenant et que je n'ai jamais vu ou entendu parler de cette méthode de production de documentation au niveau des paquets.
package-info.java dans votre paquet pour documenterLe lien suivant fournit de plus amples informations : http://docs.oracle.com/javase/specs/jls/se5.0/html/packages.html
Il est recommandé que package-info.java, s'il est présent, prenne la place de package.html pour javadoc et d'autres systèmes similaires de systèmes de génération de documentation similaires
Les annotations relatives au paquet seront également déclarées dans package-info.java.
Salut, GHad
Je n'ai jamais entendu parler de cette méthode auparavant. Pouvez-vous fournir un lien vers un document qui la décrit ?
Vous devez faire un package.html située dans le paquet. Vous pouvez lire le contenu et la structure de ce fichier sur le site Web de la Commission européenne. Comment rédiger des commentaires de doc pour la page de l'outil Javadoc .
Il y a deux façons d'ajouter de la documentation au niveau du paquet en utilisant javadoc :
Plus de détails et d'exemples sont aquí . Lequel utiliser ? Javadoc : package.html ou package-info.java
Google a trouvé ceci comme premier résultat :
http://www.oracle.com/technetwork/java/javase/documentation/index-137868.html#packagecomments
Il suffit de créer un fichier nommé package.html dans chaque paquet.
Je pense qu'ils vont dans le paquet Root. Ça a du sens d'essayer. Je ne sais pas si ça a changé depuis que j'ai répondu à cette question il y a trois ans.
Prograide est une communauté de développeurs qui cherche à élargir la connaissance de la programmation au-delà de l'anglais.
Pour cela nous avons les plus grands doutes résolus en français et vous pouvez aussi poser vos propres questions ou résoudre celles des autres.
