Lamiae
La déclaration des classes et des interfaces
Les différents éléments qui composent la définition de la classe ou de l’interface devraient être indiqués dans l’ordre suivant :
1. les commentaires au format javadoc de la classe ou de l’interface
2. la déclaration de la classe ou de l’interface
3. les variables de classes (déclarées avec le mot clé static) triées par ordre d’accessibilité : d’abord les variables déclarées public, protected,
package friendly (sans modificateur d’accès) et enfin private
4. les variables d’instances triées par ordre d’accessibilité : d’abord les variables déclarées public, protected, package friendly (sans modificateur d’accès) et enfin private
5. le ou les constructeurs
6. les méthodes : elles seront regroupées par fonctionnalités plutôt que selon leur accessibilité
La documentation du code
Il existe deux types de commentaires en Java :
les commentaires de documentation : ils permettent en respectant quelques règles d’utiliser l’outil javadoc fourni avec le J.D.K. qui formate une documentation des classes, indépendante de l’implémentation du code, les commentaires de traitements : ils fournissent un complément d’information dans le code lui-même.
Les commentaires ne doivent pas être entourés par de grands cadres dessinés avec des étoiles ou d’autres caractères.
Les commentaires ne devraient pas contenir de caractères spéciaux tels que le saut de page.
Les commentaires de documentation
Les commentaires de documentation utilisent une syntaxe particulière utilisée par l’outil javadoc de Sun pour produire une documentation standardisée des classes et interfaces au format HTML. La documentation de l’API du J.D.K. est le résultat de l’utilisation de cet outil de documentation.
…
Si le lien ne fonctionne pas correctement, veuillez nous contacter (mentionner le lien dans votre message)Cours JAVA/J2EE (364 KO) (Cours PDF)
