Normes proposées

Note :
  • les références de modèles de code correspondent au projet Outils et sont à récupérer ici :
http://outils.codeplex.com/SourceControl/ListDownloadableCommits.aspx

Entête :
  • Dans le dossier Outils/Modeles, utiliser le modèle EnteteClasse.tt pour rajouter un entête sur une classe existanteCorpsClasse.tt par copier/coller

Classe :
  • Dans le dossier Outils/Modeles, utiliser le modèle CorpsClasse.tt pour générer la classe souhaitée et la copier dans une nouvelle classe
  • Nom de classe : notation "CamelCase"

Test :
  • Un modèle de classe est disponible dans Outils/Test (UniteTest.tt)
  • Ou utiliser l'assistant d'ajout de tests présent dans le cas des versions professionnelles

Convention de nommage :
  • Variables locales : notation "Hongroise", sauf pour les variables classiques de boucle (i, j, k, l, ...)
  • Propriétés : notation "CamelCase"
  • Attributs privés : notation "Hongroise"
  • Paramètres de méthodes/fonctions : notation "CamelCase", première initiale en minuscule
  • Méthodes, fonctions : notation "CamelCase"
  • Utiliser des verbes à l'impératif pour le début des noms de méthodes/fonctions
  • Utiliser Est??? pour les fonctions booléennes
  • Objets / Composants .Net : nom de la classe, première initiale en minuscule
  • Autant que possible utiliser un vocabulaire et des termes francophones

Notation hongroise :

Préfixes Description
i int (entier)
n short int (entier court)
l long int (entier long)
f float (nombre à virgule flottante)
d double (float double)
m decimal
c char (caractère)
by byte (caractère non signe)
b boolean (booléen)
s string (chaine de caractères)
w word (mot = double octet)
dw double word (double mot)
dt Date et heure (DateTime)


Modificateurs Description
t array (tableau)
attributs privé (variable membre). Préfixer par 'this.' lors de l'utilisation.


Commentaires :
  • Au minimum, utiliser les balises de signature suivantes :

        /// <summary>
        /// Retourne une chaine contenant n groupes de blancs.
        /// </summary>
        /// <param name="nombreTabulations">Nombre de Tabulations.</param>
        /// <returns>Une chaine de blancs.</returns>
}
  • Dans le corps des méthodes, aérer, mettre des commentaires lorsqu'ils sont judicieux.
  • Les propriétés seront également commentées :

        /// <summary>
        /// Retourne la version du système d'exploitation.
        /// </summary>
        public static string VersionSystemeExploitation
        {
            get { return Environment.OSVersion.ToString(); }
        }


Idem pour les énumérations, structures publiques, etc...

Last edited Dec 30, 2009 at 3:03 PM by developpeur, version 2

Comments

No comments yet.