Documenter son code
     Suivant

Documenter son code

Yves Mettier

Copyright © 2001 Yves Mettier

Creative Commons License
Cette création est mise à disposition sous un contrat Creative Commons.

L'article original se trouve sur http://ymettier.free.fr/articles_lmag/.

Article publié dans le numéro 33 (novembre 2001) de GNU/Linux France Magazine

Table des matières

1. Introduction
2. Documentez le projet...
2.1. ...pour l'utilisateur novice
2.2. ...pour l'utilisateur expérimenté
2.3. Gardez une trace de ce qui se fait ou de ce qui est à faire
3. Documentez le code
3.1. L'algorithme, la structure de données et le commentaire
4. Bien programmer: soyez cohérent
4.1. Les noms de variables
4.2. Un seul exemplaire des données
4.3. Les noms des fonctions
4.4. Les commentaires
5. Bien programmer: évitez la redondance
5.1. #define
5.2. Ne faites pas n'importe quoi avec les constantes
5.3. Les énumérations
5.4. Les noms des constantes
5.5. Encapsulation ou pseudo-héritage de structures
5.6. Le copier/coller est dangereux
6. Bien programmer: les commentaires sont toujours redondants
7. Contrôler les données
7.1. Les données en entrée et en sortie
7.2. Les données de fonctionnement
8. Conclusion
9. Références

Résumé

Mettez des commentaires! Qui n'a pas déjà développé du code sans s'entendre dire de mettre des commentaires, par le prof, les copains, le chef, le collègue, d'autres personnes? Cet article s'adresse à ceux qui ne mettent pas de commentaires, soit par flemme, soit par vocation. Cet article s'adresse à ceux qui mettent des commentaires, et qui voudraient documenter de manière encore plus intelligente. Cet article n'est pas un article sur les commentaires, mais sur la manière de documenter son code.

création est mise à disposition sous un contrat Creative Commons

© 2001 Yves Mettier

     Suivant
     1. Introduction