Suite au billet de babozor publié sur TDW sur les conventions de programmation et surtout qu’il m’a gentiment taggué, je me permets d’y participer aussi même si en général c’est pas trop ma tasse de thé ce genre de chaînes mais pour une fois que ça touche au dév je ne peux que saluer l’initiative.
Petit exemple de code
Notation
J’utilise essentiellement la notation lowerCamelCase même si à un moment j’ai été “séduit” par la notation hongroise que je délaisse de plus en plus car je trouve qu’elle fait doublon avec l’usage des balises phpdoc.
Indentation
Tabulation 4 espaces, je crois que c’est le paramètre par défaut dans TextMate.
Un peu comme tout le monde, j’indente quand je rentre dans un nouveau bloc (conditions, boucles, etc…).
Accolades
Je suis plutôt adeptes de mettre les accolades à la suite de l’instruction plutôt que sur une nouvelle ligne. Question de goût là.
Je les omets quand c’est une instruction à une ligne ou alors j’utilise la syntaxe alternative notamment dans les templates.
Par exemple,
if($bidule == 'hello world') :
//code ici
endif;
Guillemets
J’utilise sans vraiment de distinctions les double quotes et les simples quotes même si je privilégie les simples quotes pour une raison de performances.
Espaces
J’en utilise essentiellement pour séparer les opérandes, pour tout ce qui conditions, boucles,etc… je ne mets pas d’espace entre le mot clé et les parenthèses par exemple.
Commentaires
Par habitude, je suis assez explicite dans mes commentaires mais si en général le code parle de lui même.
Par convention, j’utilise les balises phpdoc qui permettent en un clin d’oeil de savoir ce que fait tel ou tel fonction.
Je ne commente pas toujours, pour des raisons de temps (malheureusement des deadlines serrés ne sont pas toujours compatible avec un code 100% clean) mais j’essaye d’y revenir une fois la tempête passé pour commenter ou améliorer le code.
J’essaye de respecter au maximum les conventions communes au niveau des développeurs php et essayer de faire en sorte que mon code soit compréhensible même pour quelqu’un n’ayant jamais touché à cette partie du projet.
J’use et abuse de la programmation objet également pour bien séparer les différentes parties d’une classe et faciliter ses tests de manière automatisé (phpunit, simpletest, …) ou manuelle.
J’essaye d’utiliser l’anglais au sein de mes classes mais j’ai tendance à plutôt documenter mon code en français. Il faudrait que je me décide de ce côté là :p
Qui a dit que le code ne ressemblait pas à de la poésie ?
Et vous, quels sont vos conventions de code ?
Leave a Reply