Conventions
de codage
Règles minimum à respecter
Commentaires
- Chaque fichier commence par un cartouche d'information où l'on retrouvera
:
- le nom du fichier
- sa version
- informations de copyright
- classes qu'il contient
- auteur d'origine
- grande fonctionnalité
// $Id: cApogee.java,v 1.0 16/05/2003
// Copyright (c) 2003 Esup Portail (www.esup-portail.org)
// ...
// Classes: cApogee
// Original Author: Olivier Ziller
- Utilisez Javadoc pour décrire aux minimum :
- les classes,
- les méthodes,
- les variables
- Si vous devez écrire beaucoup de commentaires dans le corps des procédures
et fonctions, c'est bien souvent le signe qu'il est nécessaire de les
scinder car elles deviennent trop complexes.
- Toujours penser à noter les améliorations futures à
apporter à l'aide de la notation :
// TODO : penser à utiliser ces normes dans mes développements!
Règles communes
- La première lettre de chaque mot est en majuscule sauf pour le premier
mot
- Toutes les variables et méthodes commencent donc par une minuscule
- Il n’y a pas de séparateur entre les mots.
Règles concernant les variables
- Les constantes sont en majuscules
- Si vous devez rendre accessible vos variables, créez des accessors
get et set en
les déclarant eux-mêmes public ou protected. Donc il n'existe
pas de variable globale pour une classe.
Règles concernant les méthodes
- Les paramètres doivent être séparés par virgule+espace
Règles concernant les classes
- Toutes les classes commencent par une majuscule
- Le nom du fichier comporte le même nom que la classe principale
- Dans un package, la classe principale comporte le même nom que le
package. Toutes les autres classes commencent par ce nom.
- voir aussi les règles concernant les noms des packages
Style d'écriture du code
Sources
