Convention de codage

[pic 1]

Sommaire

1.        Préambule        2

2.        Consignes d’ordre général        2

3.        Conventions de codage C#        2

3.1        Styles de capitalisation        2

3.2        Conventions de disposition        3

3.3        Conventions de commentaires        3

4.        Conventions de nommage C#        3

1. Préambule

Le présent document récapitule les principales conventions de codage et de nommage à adopter par l’équipe TMA du système « WF Backbones ».

1. Consignes d’ordre général

Ci-après, une série de bonnes pratiques à respecter lors de la maintenance corrective et évolutive du code source et de la base de données du système « WF Backbones » :

• L’actualisation du modèle de données (tables, Indexes, clefs primaires et étrangères) est centralisée chez le Chef d’équipe pour éviter les incohérences. Les membres de l’équipe peuvent, cependant, proposer des optimisations et/ou des améliorations.
• Les choix techniques (architecture, outils, frameworks, niveau de paramétrage, objets partagés, séparation des couches, logique d’intégration, …) doivent être validés par le Chef d’équipe et éventuellement le Directeur de projet (si besoin) après concertation avec tous les membres de l’équipe.
• Eviter le codage en dur et essayer toujours de passer par un fichier/une table de paramétrage.
• Les noms des objets BDD temporaires doivent commencer par les initiales de leurs créateurs et doivent être supprimés en fin d’intervention.
• La gestion des exceptions est obligatoire dans toutes les fonctions et les couches → il faut bien gérer la zone « catch », Cacher une erreur n’est pas une bonne solution.
• Afficher les messages d’erreurs dans la zone appropriée avec un petit retrait (même retrait dans toutes les pages)
• Rassembler les traitements liés aux droits d’accès dans des procédures prenant en argument le profil en question
• Penser toujours à donner de la valeur au code source en mettant en évidence une abstraction procédurale →  il faut éviter au max. les « IF imbriqués » et les traitements longs et illisibles par l’usage de procédures et de fonctions (remarque valable pour C# et Transact-SQL)
• Avant de livrer un module, il faut absolument faire une revue du code (Indentation, lignes vides à supprimer, les commentaires inutiles à enlever, …) et dérouler les tests unitaires.
• L’archivage du code dans TFS soit être systématique et journalier (même si le module en cours n’est pas encore finalisé).
• Consignes Transact-SQL :

• Une procédure stockée qui retourne une seule valeur et qui ne fait aucun traitement de màj dans la BDD n’a aucun sens → il s’agit en fait d’une fonction
• Une vue doit afficher des colonnes nommées correctement
• Une requête SELECT doit nécessairement avoir une clause ORDER BY (par défaut = clef primaire)
• Nommer explicitement les variables et ne pas utiliser des noms pour un contexte non adéquat

1. Conventions de codage C#

1. Styles de capitalisation

Ci-après les 3 styles de capitalisation à adopter :

• Pascal case : 1ière lettre de chaque mot en majuscule et mots collés sans aucun séparateur.

Exemple: BackColor, DataSet

• Camel case : 1ière lettre en minuscule, ensuite, 1ière lettre de chaque mot concaténé en majuscule

Exemple: numberOfDays, isValid

• Uppercase : Toutes les lettres en majuscule

Exemple: ID, PI

1. Conventions de disposition

Une bonne disposition utilise la mise en forme pour souligner la structure du code et en faciliter la lecture.

Consignes à respecter :

• Utiliser les paramètres par défaut de l'éditeur de code (retrait intelligent, retrait de quatre caractères, tabulations enregistrées en tant qu'espaces). 
• Écrire une seule instruction par ligne.
• Écrire une seule déclaration par ligne.
• Si les lignes qui se suivent ne sont pas mises en retrait automatiquement, mettez-les en retrait d'un taquet de tabulation (quatre espaces).
• Ajouter au moins une ligne blanche entre les définitions des méthodes et les définitions des propriétés.
• Utiliser des parenthèses pour rendre apparentes les clauses d'une expression, comme illustré dans le code suivant.

[pic 2]

1. Conventions de commentaires

• Placer le commentaire sur une ligne séparée, pas à la fin d'une ligne de code.
• Commencer le commentaire par une lettre majuscule.
• Terminer le texte de commentaire par un point.
• Insérer un espace entre le délimiteur de commentaire (//) et le texte du commentaire, comme illustré dans l'exemple suivant.

[pic 3]

• Ne créer pas de blocs d'astérisques mis en forme autour des commentaires.

1. Conventions de nommage C#

Private & Local Variables : Utiliser le style de capitalisation « camel case » de façon générale ou le style « uppercase » pour les petits mots.

...