Coder propre - Partie 1

[Shivaan Keldon]

Bonjour à tous
Etant un programmeur professionnel depuis 8 ans, j'avais envie de vous faire partager certaines règles, méthodes ou automatismes de la programmation qui pourraient vous être utile aussi bien pour votre propre codage que pour la communication de celui-ci avec les autres

1) Les commentaires
Beaucoup de programmeurs (généralement amateurs, sans être péjoratif) zappent volontairement les commentaires pour gagner du temps sur la production de code. C'est, de mon point de vue, une grosse erreur. En effet, les commentaires sont utiles pour plusieurs raisons. Ils permettent :
- d'exprimer la logique du code dans un langage facilement compréhensible par tous
- de garder un historique
- de s'y retrouver facilement à la lecture du code (que ce soit par quelqu'un d'autre, ou par soi-même quand on a plus vu le code depuis longtemps)
- de générer de la documentation grâce à des outils
- de retrouver facilement quelle est l'utilité d'un bout de code, d'une fonction ou d'une variable
Il est donc très important de fournir des commentaires complets, d'autant plus que le moteur de compilation ou d'interprétation les zappe automatiquement. Voici quelques exemples

a) Fonction ou classe

Code PHP :

<?php 

/**

  * Fonction getObject()

  *   retourne l'objet après qu'il soit alimenté par la base de données

  * Params : (int) id

  * Return : (objet) monObjet

  * version : 1.0

  * autheur : Shivaan Keldon (email)

  * date : 10/06/2008

  ****

  * modif : ajout de la propriété nom

  * version : 1.1

  * autheur : Shivaan Keldon (email)

  * date : 11/06/2008

  **/

function getObject($id) {

...

}