Chapitre 7. Conventionsde programmation et de documentation
Cet ouvrage a été traduit à l'aide de l'IA. Tes réactions et tes commentaires sont les bienvenus : translation-feedback@oreilly.com
Ce chapitre explique plusieurs conventions importantes et utiles en matière de programmation Java et de documentation. Il aborde :
-
Les conventions générales de nommage et de majuscules
-
Conseils et conventions de portabilité
-
Syntaxe et conventions des commentaires de documentation
javadoc
Conventions de nommage et de majuscules
Les conventions de nommage suivantes, largement adoptées, s’appliquent aux modules, paquets, classes, interfaces, méthodes, champs et constantes en Java. Comme ces conventions sont presque universellement respectées et qu’elles ont une incidence sur l’ API publique des classes que tu définis, tu devrais les adopter toi aussi :
- Modules
-
Comme les modules sont l'unité de distribution privilégiée pour les applications Java à partir de Java 9, tu dois faire particulièrement attention quand tu les nommes.
Les noms de modules doivent être uniques au niveau mondial : le système de modules repose essentiellement sur ce principe. Comme les modules sont en fait des super-paquets (ou des agrégats de paquets), le nom du module doit être étroitement lié aux noms des paquets regroupés dans ce module.
Une méthode recommandée consiste à regrouper les paquets au sein d’un module et à utiliser le nom racine de ces paquets comme nom de module. Par exemple, si tous les paquets ...
Become an O’Reilly member and get unlimited access to this title plus top books and audiobooks from O’Reilly and nearly 200 top publishers, thousands of courses curated by job role, 150+ live events each month,
and much more.
Read now
Unlock full access