En développement informatique on trouve différentes » bonnes pratiques « , dont certaines varie d’un développeur/formation/entreprise à un.e autre. Aperçu de certaines des plus communes et connues.
Déclaration et initialisation liées
Il est recommandé, dans un code, de joindre l’étape de déclaration d’une variable à l’étape d’initialisation.
Objet monObjet = new Objet();
Cela permet d’éviter d’avoir à manipuler par erreur des objets null entre l’étape de déclaration et d’initialisation. On dit que les opérations réalisées entre ces deux opération représente une fenêtre de vulnérabilité : le code présent entre ces deux étapes pourrait occasionner des erreurs.
Casses des données
Une convention veut que selon le type de donnée et son accessibilité, la façon de l’écrire varie. Ainsi, une variable locale sera toute en minuscule ainsi qu’un membre de classe privée qui lui sera précédé d’un underscore (_). Les propriétés (et accesseurs) commenceront généralement par une majuscule ainsi que le nom des classes.
//variable locale
int number = 0;
//Membre privé d'une classe
private int _number
//propriété ou accesseur
public int Number {get; set;}
Nommage des données
De manière générale, le language privilégié est l’anglais.
Les méthodes commenceront par une majuscule et seront identifiées par un verbe. On s’attendra à ce que le verbe « Get » retourne un objet (au lieu d’alimenter un membre privé).
Les Interface seront quant à elles précédées de « I » et les Enum de la lettre « E ».
//methode
private void CreateNewValue(){...}
public int GetNumber(){...}
//Interface
public interface IData { ... }
//Enum
public enum EStatus { status1, status2... }
Sources
- http://pageperso.lif.univ-mrs.fr/~arnaud.labourel/dii_code_style/?declaring_initializing
- Expérience professionnelle