Bonnes pratiques pour le développement

(Différences entre les versions)

Version du 7 avril 2008 à 10:15

Cette page liste des bonnes pratiques pour le développement de logiciel. La première version est issue d'un journal linuxfr de Papa Furax.

Utiliser un gestionnaire de version du code source (ex: Subversion)
Automatiser un maximum de chose, exemples :
- Lancer automatiquement des tests (« tests unitaires »)
- Générer la documentation à partir du code source
- etc.
Activer la détection de tous les avertissements (ex: avec gcc, utiliser -Wall -Wextra voire -Werror) et surtout les corriger
- Voir également utiliser des outils dédiés : splint et Valgrind (langage C), pylint et pychecker (Python), etc.
Indenter le code source
Ne pas écrire de fonction de plus de 300 lignes
- Si une fonction est plus longue, on peut forcément la redécouper
Limiter le nombre d'arguments d'une fonction (ex: 5 maximum)
Écrire de la documentation
Écrire des tests (tests unitaires, tests fonctionnels, fuzzing, etc.)
Utiliser des conventions de : nommage des variables, fonctions, classes et constantes, langue du code source (l'anglais pour un logiciel libre, si vous souhaitez recevoir des contributions...)
Éviter la redondance : factoriser le code, réutiliser du code, recherche les bibliothèques existantes avant de réinventer la roue

Autres bonnes pratiques :

 ** Générer la documentation à partir du code source
 ** etc.
-* Activer la détection de tous les avertissements (ex: avec gcc, utiliser -Wall -Wextra voir même -Werror) et surtout les corriger
+* Activer la détection de tous les avertissements (ex: avec gcc, utiliser -Wall -Wextra voire -Werror) et surtout les corriger
 ** Voir également utiliser des outils dédiés : splint et  Valgrind (langage C), pylint et pychecker (Python), etc.
 * Indenter le code source