Remerciez-le!

Remerciez @Admin pour avoir partagé cet document gratuitement, de la manière la plus simple, en partageant sur les réseaux sociaux.

Conseils de codage en C Sommaire Maintenabilité Pour la lisibilité Pour la déte

Conseils de codage en C Sommaire Maintenabilité Pour la lisibilité Pour la détection des erreurs Pour des modifications plus faciles Fiabilité Un livre de Wikilivres. Une version à jour et éditable de ce livre est disponible sur Wikilivres, une bibliothèque de livres pédagogiques, à l'URL : http://fr.wikibooks.org/wiki/Conseils_de_codage_en_C Vous avez la permission de copier, distribuer et/ou modifier ce document selon les termes de la Licence de documentation libre GNU, version 1.2 ou plus récente publiée par la Free Software Foundation ; sans sections inaltérables, sans texte de première page de couverture et sans Texte de dernière page de couverture. Une copie de cette licence est inclue dans l'annexe nommée « Licence de documentation libre GNU ». == == == Lisibilité des sources Les conseils suivants rendent les logiciels plus maintenables. Leur respect a pour but de : faciliter la lecture des codes sources écrits en C diminuer l'effort nécessaire pour diagnostiquer les déficiences ou causes de défaillance, ou pour identifier les parties à modifier. Cartouche d'entête (c_lis_1) Chaque fichier source (.c, .h) et chaque fonction C doivent être précédés Conseils de codage en C/Version imprimable — Wikilivres https://fr.wikibooks.org/w/index.php?title=Conseils_de_codage_en_C/... 1 sur 29 14/07/2015 00:38 Pour la robustesse Pour les performances Pour la sécurité Qualité Pour une utilisation plus facile Pour la qualité numérique Livre Programmation C Modifier le sommaire d’un cartouche qui pourra contenir : Le nom de l'unité ou de la fonction. Son rôle et ses points de programmation critiques. Pour une fonction, la description des arguments et des codes retours. La date, l’auteur et le rôle de chaque modification. Sa licence et droits d'utilisation La mention de documents de conception ou de référence Justification Le cartouche de l’unité permet de faciliter sa compréhension d'un point de vue général. Les cartouches de fonctions permettent de comprendre leur rôle et conditions d'appel sans se plonger dans le code source . Ces entêtes sont indispensables à la gestion de la configuration et à la maintenance. Exemple /******************************************************* Nom ......... : limites.c Role ........ : Affiche les caractéristiques numériques pour les types du langage C Auteur ...... : Thierry46 Version ..... : V1.1 du 10/3/2008 Licence ..... : GPL Compilation : gcc -Wall -pedantic -std=c99 -o limites.exe limites.c Pour exécuter, tapez : ./limites.exe ********************************************************/ Outils La plupart des environnements de développement bâtissent un squelette de cartouche d'entête lors de la création d'un nouveau fichier Pour les projets importants, développés en équipe, les versions des fichiers sources pourront être gérées par un logiciel spécialisé comme CVS, subversion... L'utilisation d'un outil de gestion de la documentation comme Doxygen permet, à l'aide d'une syntaxe particulière dans les commentaires, de générer à partir des sources la documentation de programmation du projet. Indentation des instructions (c_lis_2) Les instructions imbriquées sont indentées à l’aide de tabulations ou d'espaces de façon homogène dans tous les fichiers sources du projet. Justification La maintenance et la relecture des sources sont facilités par une présentation homogène. Exemple (extrait) Conseils de codage en C/Version imprimable — Wikilivres https://fr.wikibooks.org/w/index.php?title=Conseils_de_codage_en_C/... 2 sur 29 14/07/2015 00:38 //... // Teste si les valeurs lues sont les valeurs attendues. for (i=0; i<(int)nbInt; i++) { (void)printf("%d, ", valIntLu[i]); if ( valIntLu[i] != valInt[i] ) { (void)printf("Au lieu de %d\n", valInt[i]); exit(EXIT_FAILURE); } } Outils L'outil UNIX indent permet d'améliorer la présentation des fichiers sources écrits en C. De nombreuses options permettent de paramètrer le style de ses sorties. Elles peuvent être passées sur la ligne de commande ou mieux dans un fichier de configuration spécifique. Indentation des commentaires (c_lis_3) Les commentaires suivent l’indentation des instructions de code. Justification Augmente la lisibilité. Une instruction par ligne (c_lis_4) Ne pas écrire plus d'une instruction par ligne. Justification Augmente la lisibilité. Décomposer les instructions longues (c_lis_5) Coder des lignes simples. Justification Il est quelquefois tentant de coder des lignes longues : Dans le domaine numérique, le programmeur écrit des formules compliquée juxtaposant de nombreuses fonctions et opérateurs. Le langage C permet de mélanger tests, appel de fonctions, opérations. Le code parait, à première vue, plus compact, plus efficace. Il faut cependant décomposer les lignes longues en plusieurs, en utilisant des variables intermédiaires. Les compilateurs récents se chargeront d'optimiser efficacement le code pour vous. Le résultat sera plus facile à comprendre par d'autres. Les problèmes de priorité pourraient être atténués. Conseils de codage en C/Version imprimable — Wikilivres https://fr.wikibooks.org/w/index.php?title=Conseils_de_codage_en_C/... 3 sur 29 14/07/2015 00:38 Constantes symboliques et macros en majuscule (c_lis_6) Les noms des constantes symboliques et des macros instructions doivent être écrits en majuscule. Justification Dans un fichier source, permet des distinguer rapidement les constantes des variables. Exemple #define LONGUEUR_NOM_FICHIER 15 #define STR(s) #s #define XSTR(s) STR(s) Pas de lignes trop longues (c_lis_7) Les instructions ne doivent pas dépasser la colonne 80. Les instructions longues doivent être placées sur plusieurs lignes. Justification Les lignes courtes seront plus faciles à comprendre par une personnes chargée de maintenir le logiciel. Exemples Mauvais : #define sonne(N) { int n; for (n=N; n>0; n--) fputc(0x7, stderr);} (void)printf("\nProgramme %s, fichier source "__FILE__"\nCompile le "__DATE__" a "__TIME__ Meilleur : #define sonne(N) \ { \ int n; \ for (n=N; n>0; n--) fputc(0x7, stderr); \ } //... (void)printf("\nProgramme %s, fichier source "__FILE__ "\nCompile le "__DATE__" a "__TIME__"\n", argv[0]); Nommage des identificateurs (c_lis_8) Vous devez donner des noms significatifs aux identificateurs. Évitez les noms trop courts sans signification fonctionnelle : v, vv, vvv... Ne différenciez pas deux identificateurs uniquement en changeant la casse de certains caractères : Fichier, fichier. Conseils de codage en C/Version imprimable — Wikilivres https://fr.wikibooks.org/w/index.php?title=Conseils_de_codage_en_C/... 4 sur 29 14/07/2015 00:38 Ne différenciez pas deux identificateurs uniquement par un nombre trop restreint de lettres. N'utilisez pas de caractère souligné en tête ou en fin d'identificateur. Utiliser une règle de nommage cohérente dans le projet : mot séparés par des soulignés (fichier_parametres_calcul) ou mots collés commençant par des majuscules sauf première lettre (fichierParametresCalcul). Justification Facilite la lisibilité et la maintenabilité. Cohérence des identificateurs (c_lis_9) Dès lors qu’un identificateur de variable est défini pour une entité significative, il faut utiliser ce même identificateur quelle que soit l’unité de code considérée. Justification Facilite l'analyse du programme. Arguments du programme principal (c_lis_10) Les arguments du programme principal sont standards : int main(int argc, char *argv[]) Justification Améliore la lisibilité du code. argv[0] représente le nom de lancement du programme et peut être utilisé pour les messages d'erreur. La récupération des arguments du programme pourra se faire avec les fonctions getopt(), getsubopt(). Limiter l'utilisation des opérateurs ++ et -- (c_lis_11) Les opérateurs ++ et -- ne sont autorisés que pour les indices de boucles et les pointeurs, à condition qu’aucun autre opérateur n’apparaisse et que seule l’utilisation post-fixée soit utilisée. Justification Facilite l’analyse et la maintenance par des programmeurs habitués à d’autres langages. Exemple Correct : for (i=0; i<n; i++) {//.... Moins bon : t[i++]=f(i++); Limiter l'utilisation de l'opérateur de test ternaire (c_lis_12) L’utilisation de l’expression conditionnelle ? : est interdite en dehors des macros. Justification Conseils de codage en C/Version imprimable — Wikilivres https://fr.wikibooks.org/w/index.php?title=Conseils_de_codage_en_C/... 5 sur 29 14/07/2015 00:38 Facilite l’analyse et la maintenance par des programmeurs habitués à d’autres langages. Ne pas économiser les accolades (c_lis_13) Utilisez des accolades {} autour d'une ou des instructions d'un bloc. Ce bloc peut faire partie d’une structure de contrôle comme if - else - for - do - while. Justification Rend le code plus lisible et évite les erreurs lors de l'ajout d'une instruction dans un bloc qui n'en contient qu'une seule. Exemple Mauvais : for (i=0; i<n; i++) table[i] = 1; Meilleur : for (i=0; i<n; i++) { table[i] = 1; } Exemple d'erreur provoquée par la violation de ce conseil : if (test == 2) { for (i=0; i<n; i++) table[i] = 1; table2[i] = 2; } /* Suite... */ L'instruction table2[i] = 2; donne faussement l'impression de faire partie de la boucle for, ce qui est renforcé par l'indentation et l'accolade fermante du if. Si table2 était dimensionné à n, les indices acceptables iraient de 0 à n-1 inclus. Lors de l'exécution de l'instruction table2[i] = 2;, i vaudrait la valeur n, ce qui provoquerait l'écriture d'une valeur hors de l'espace mémoire réservé pour le tableau table2. Il s'en suivra : Le débordement hors de l'espace utilisateur qui provoquera une violation mémoire : Sanction rapide par arrêt du programme exception SIGSEGV. L'écrasement du contenu d'un autre pointeur situé juste après l'espace table2 qui lorsqu'il sera utilisé plus tard (100 lignes plus bas ?) provoquera une autre catastrophe : Cette erreur peut être difficile à détecter sans l'utilisation d'un outil qualité d'analyse dynamique. Ces erreurs peuvent arriver aléatoirement selon le système, le compilateur utilisé ou le chargement du Conseils de codage en C/Version imprimable — Wikilivres https://fr.wikibooks.org/w/index.php?title=Conseils_de_codage_en_C/... 6 sur 29 14/07/2015 00:38 programme en mémoire. Bien aligner les accolades (c_lis_14) Une accolade fermante se trouve toujours à la verticale de l’accolade ouvrante correspondante. Justification Permet de mieux repérer les blocs d'instructions conditionnelles, les corps de boucles surtout en cas de structures imbriquées. Exemple // Compilation : gcc -Wall -pedantic -std=c99 -o essai.exe essai.c #include <stdio.h> #include <stdlib.h> int main(void) { const int nbLigne = uploads/Litterature/ conseils-de-codage-en-c-fr 1 .pdf