Retour : Page Principale > sommaire méthodologie

---

Conventions de codage Tela Botanica

Y en a pas. Mais ça ne veut pas dire qu'on doit coder salement !
Si votre expérience ne vous suffit pas pour avoir une idée de ce qui est lisible/propre ou ne l'est pas, les exemples de conventions listées ci-dessous donnent de bonnes bases pour faire des trucs pas trop crades.
Pour les logiciels déjà existants, préférer s'adapter au style de code en place pour conserver la cohérence.

Pourquoi une convention de codage ?

Pour mieux communiquer entre développeurs, favoriser et simplifier la relecture, éviter les bugs.
L'objectif d'une convention de codage n'est pas de brider le programmeur ou de le ralentir dans ses développements, mais d'offrir un cadre de développement pour communiquer plus facilement.
Un code compréhensible est plus facile à maintenir.

Exemples de conventions sympa

Ce n'est pas forcément exactement ça qu'il faut appliquer comme des psychopathes, mais ça donne de bonnes idées.

PHP

http://www.php-fig.org/psr/psr-1
http://www.php-fig.org/psr/psr-2

Javascript

https://www.w3schools.com/js/js_conventions.asp
https://google.github.io/styleguide/jsguide.html

HTML / CSS

https://www.w3schools.com/html/html5_syntax.asp
https://cssguidelin.es
https://github.com/airbnb/css

Java

https://www.securecoding.cert.org/confluence/display/java/Java+Coding+Guidelines
https://google.github.io/styleguide/javaguide.html

Annexe : bonnes pratiques hors convention

Requêtes SQL

Afin d'identifier plus facilement les problèmes de performances (slow queries) où de comprendre l'origine de bugs (general_log), ajouter un commentaire aux requêtes complexes indiquant le fichier source et la ligne. Exemple :

---