Qu'est ce que cela veux dire un "code propre" selon-vous ? [Débat]

[Dsphinx]

Un code propre c'est la règle des 4C (dixit Dsphinx. C'est que je dis à ceux qui se lancent le code !) !

• Clair
• Compréhensible
• Commenté
• Convivial pour tous

[Gugelhupf]

Un code propre pour moi c'est :

Un code qui ne réinvente pas la roue, qui utilise les API du standard (sauf cas très particuliers comme JodaTime en Java).

Éviter les fonctions dépréciées.

Utiliser les ternaires au lieu de if/else simples c'est bien, par contre abuser des ternaires pour faire des ternaires imbriqués c'est mal !

Respecter une convention d'écriture :
Par exemple les noms de classe en UpperCamelCase, le nom des variables ou fonctions en lowerCamelCase, les constantes en MAJUSCULES séparés par des underscores.
Respecter l'indentation (4 espaces).
Enfin bref, ceux qui font du Java connaissent les conventions Java, ceux qui font du PHP connaissent le PSR etc...

Éviter les for ou itérateurs, utiliser foreach lorsque cela possible, c'est tellement pratique pour parcourir les tableaux !

Éviter de créer des fonctions de plus de 40-50 lignes.

Des commentaires bien répartis, et surtout là où il en faut. Faire une belle description d'une classe en en-tête de fichier ou créer une documentation technique compréhensible.

Dans la programmation objet :
Utilisation de l'encapsulation. Une fois j'ai vu une classe PHP sans attributs, en faite tous les attributs étaient créés dynamiquement à partir du constructeur. Du coup les classes n'avaient que des attributs public, et même que l'IDE n'arrivaient pas à détecter.

L'héritage c'est bien mais éviter d'avoir plus de 4 couches d'héritage, après c'est le gros bordel.

Dans le Web, ou architecture MVC :
Bien découper Modèle-Vue-Contrôleur, je vois encore des cas où il y a des chaines de balises HTML dans le Contrôleur... ou bien du code métier dans la Vue.

J'ai surement du oublier des trucs, il y a tellement de petits détails comme ceux-là...

[imikado]

Il existe des outils pour auditer votre code, cela permet d'avoir une relecture de la totalité de votre code.

Après libre à vous de suivre les recommandations...

C'est outil, c'est sonar http://www.sonarsource.org/

Il est multi langage, il est gratuit et permet d'auditer votre code de manière automatique

Il peut aussi bien vérifier le pourcentage de commentaire, que les variables non utilisées, les methodes trop longue/ trop complexe...