Façon d'écrire votre code

Bonjour à tous, je me posais la question suivante:
N'ayant pas suivi de formation pour apprendre à programmer (j'apprend sur le tas) je ne sais pas s'il ya une façon "générique" de coder... j'entends par là en particulier comment vous définissez les noms de vos variables, structures, classes, fonctions. Est ce que vous utiliser des majuscules des "_" genre MainFrame ou Main_Frame ou main_frame ou encore int m_count;....
C'est un topic où tout le monde est invité à présenter ça façon de voir les choses pour une meilleure clarté et ainsi apporter au autres.

Salut, chaque équipe, et parfois chaque projet, a sa propre convention de nommage. Et chaque programmeur, sa façon d'indenter. La seule règle c'est de s'adapter.

Pour les noms de variables locales je choisis les plus courts possible ex. int a, b; ça rend le code très clair. Avec une préférence pour les appeler n et i si c'est pour des boucles. Mais pour les bloucles imbriquées, t u v w ...

Beaucoup de programmeurs commencent tous les noms de variables int par un i. Les tableaux de char par psz. Je ne suis pas cette démarche mais privilégie un nom clair et en francais, le plus explicite possible, à priori sans convention. Là encore, le plus court possible: par exemple une variable nommée nombre_de_lignes me plaira moins que nbLignes.

Pour les structures, en général je l' appelle unXXX et pour un tableau de structures ça donne XXXs[]. Par exemple unMembre, et son tableau Membres[].

L' underscore est pratique pour les noms de fonctions s'il est utilisé sous la forme objet_verbe() c'est grosso modo ce que les programmeurs C++ écriraient objet::verbe() et ça a l' avantage de rassembler par thème sans se pommer donc réduire le temps de lecture.

Cependant je pense que l'indentation est beaucoup plus importante que la convention de nommage. Ce n'est que mon avis, chacun a le sien.

Une régle de base pour les noms de variable et de fonction et d'avoir des noms auto-informant, une variable nommée titi ou une fonction toto à éviter absolument. Ensuite il faut essayer de suivre ta régle de nommage sur tout le projet ne pas avoir un fichier avec des fonctions qui commencent avec une majusucule et dans un autre fichier d'autres avec une minuscule.


A part ces deux régles c'est plutot libre, tu peux lire un peu la littérature que tu trouveras sur le sujet ( notation hongroise par exemple)

Bon courage,

Perso je fais ça a la sauce java : les fonctions commencent avec une minuscule et si la fonction fait plus de 2 mots les autres qui suivent en majuscule, exemple : saisirChaine, pour les variables pareil en étant le plus clair et court possible et aprés indentation classique a chaque bloc/boucle on décalle un peu plus et pour les accolades ouvrantes je les met a la ligne et non pas a la suite, voila voila :lol:

Citation:

---

Envoyé par reptils

C'est un topic où tout le monde est invité à présenter ça façon de voir les choses pour une meilleure clarté et ainsi apporter au autres.

---

Ma position est connue :

http://emmanuel-delahaye.developpez.com/codage.htm

j'aime bien ce que tu expliques dans ta page, en particulier :
p_xx pointeur
a_xx ou sa_xx tableau statiques(static array)....
je pense que je vais m'en inspirer
En ce qui concerne les fonction j'ai plutot l'habitude d'utiliser les underscore sans majuscules.

moi en gros j'utilise :

• Des majuscules pour noms de constantes, précédées éventuellement du nom du projet si il peut y avoir des ambiguités (lien avec d'autres bibliothèques)(exemple : MACONSTANTE, MonProjet_MACONSTANTE)
• Coller les mots en mettant une lettre majuscule au début de chaque mot pour les fonctions externes, mais précédé du nom du projet et d'un _ (exemple " extern void MonProjet_CetteFonction(void)")
• Séparer les mots par un _, les démarrer par une majuscule, pour toutes les fonctions statiques (exemple "static void Cette_Fonction(void)" )
• Nom du projet suivi du nom de la structure suivi de "struct" pour les structures globales (exempe "MonProjet_DataStruct"), ou sans le nom du projet pour les structures locales (exemple "DataStruct")
• Toutes mes variables importantes avec un nom clair en toutes lettres (sauf les indices, et quelques petites variables dont la compréhension est immédiate (exemple : int numloop double Somme mais int i double d quand par exemple indice de tableau ou calcul intermédiare)
• Aucune variable globale "extern"
• Le minimum de variables globales (statiques) (atteignables par des fonctions publiques du style "get" si besoin est). Leur nom est en clair.
• Si un fichier .c a besoin de certaines structures ou constantes, un fichier .h portant le même nom que le fichier, suivi de _Structs (exemple : MesFonctions.c MesFonctions_Structs.h)
• A chaque fichier .c un fichier .h portant le même nom, contenant uniquement la définition des fonctions publiques, et incluant si besoin est le fichier *Structs.h correspondant.
• Chaque fichier .c a un nom clair (verbe + nom quand il s'agit de ça, ou juste nom) , chaque mot débutant par une majuscule, précédé éventuellement du nom du projet (exemple : TraceDonnees.c MonProjetTraceDonnees.c)
• Les fichiers sont découpés par fonctionalités (exemple : AccesDonnees.c TraceDonnees.c CreeDonnees.c)
• les répertoires sont découpés par regroupement de fonctionalités (exemple interface, images, serveurs...)
• Toutes les fonctions locales sont déclarées "static"
• Enfin éventuellement si c'est demandé une définition de constantes PRIVATE et PUBLIC (ou PRIVATE est défini come static).

Voilà..

J'en ai peut-être oublié...
:salut:

[EDIT]
Oui j'ai oublié 1 chose :

Aucun nom de fichier source > 12 caractères (sans le ".c" )

parce que...... 8O

quand on fait une bibliothèque, l'archiveur "ar" ne prend que 14 caractères.... :?

Il en prend plus, mais il tronque le nom......

Donc.... Si on veut pas se et lui mékanger les pinceaux, et comme je n'utilise que des blbiothèques, voilà..... :D

[/EDIT]