Java
« Always code as if the guy who ends up maintaining your code will be a violent psychopath who knows where you live. » Martin Golding Ce guide est un extrait traduit en français de « Code Conventions for the Java Programming Language » mis en ligne par Oracle 1 et utilisé dans l’industrie.
1 Règles de nommage
Il ne faut jamais utiliser de caractères spéciaux ou d’espace dans les noms d’identifiants (classes, variables, constantes, méthodes, ...). Il faut donc se restreindre au lettres (sans accent), aux chiffres et à la barre de soulignement. Terminologie : un mot est dit capitalisé s’il est constitué de plusieurs mots, commençant chacun par une majuscule. Par exemple, « bonjourMonsieurLeProfesseur » est un mot capitalisé.
Type Classes
Commentaire Exemples Les noms de classes devraient être des noms comclass Voiture ; muns. Ils doivent être capitalisés et commencer class GestionDesImages ; par une majuscule. Les noms des variables doivent être expressifs. Il int i ; faut limiter autant que possible les noms de vachar cp ; riables à 1 caractère. Ils doivent être capitalisés double myWidth ; et commencer par une minuscule.
Variables
Les noms de constantes doivent être écrits en f i n a l i n t MIN_WIDTH = 4 ; majuscules. S’ils sont composés de plusieurs f i n a l i n t MAX_WIDTH = 9 9 9 ; Constantes mots, alors la barre de soulignement (’_’) est utif i n a l i n t NB_OF_CPU = 1 ; lisée comme séparateur. Les noms de méthodes devraient être, ou contenir, run ( ) ; des verbes. Ils ont les mêmes règles de syntaxe runFast ( ) ; que les variables (capitalisés, commençant par getBackground ( ) ; une minuscule).
Methodes
2 Présentation des blocs
Dans un programme Java, il faut : – Ouvrir les accolades "{" sur la ligne de la structure contenant le bloc. – Fermer les accolades "}" sur la première ligne qui suit la dernière instruction. L’accolade doit être seule sur la ligne. – Décaler le contenu du bloc de