Nommer ses variables et fonctions

Bonjour à tous,

je me permet de poster ici parce que j'utilise principalement matlab mais c'est une question très générale que je viens poser.

Je suis arrivé à un point dans ma thèse ou le nombre de variables dans mes programmes est assez conséquent. Aussi j'aimerai mieux organiser la manière de les nommer (ainsi que les fonctions) pour une identification plus rapide lors de la relecture de mes codes. C'est pourquoi je viens à la pêche aux idées.

Existe t-il une sorte de tuto ou de document regroupant différentes techniques de "nommage" des variables/fonctions ?

Si non, avez-vous des conseils et/ou recommandations sur la manière de procéder ?

Existe t-il une façon de faire plus répandue que les autres ? ("_commmeCaParExemple" ou "CommeCa" ou COMMECAMAISCESTPASBEAU")

En vous remerciant.

Antoine.

Bonjour,

Il y a différentes écoles, perso j'ai adopté ceTypeDeSyntaxe. Pour nommer une variable, je commence toujours par une minuscule, et à chaque changement de mots, je mets une majuscule.

Quelques petits conseils personnels, qui n'ont rien d'absolus, juste des règles que j'essaie de m'imposer.

Dans un programme, il faut essayer d'être cohérent sur plusieurs choses. Si tu fais l'accord pluriel sur tes variables, il faut le faire sur toutes tes variables. Sinon tu les nommes toujours au singulier même si la variable contient plusieurs paramètres. Ensuite, selon le type de programme, il se peut que tu aies certaines variables un peu plus spécifiques. Dans ce cas, tu peux éventuellement mettre son type devant. Par exemple, dans une IHM, quand je manipule des edit qui contiennent des nombres, j'écris toujours la variable qui contient le string de cette façon: strMonParametre1 pour les différencier de MonParametre1 qui lui contient la valeur du paramètre.

Il va s'en dire que si tu commences à nommer tes variables et tes fonctions dans une langue, il faut garder cette langue tout au long du programme pour une meilleure cohérence. ça t'évitera de te demander si tu as écrit parameter ou parametre par exemple.

Pour les fonctions, j'essaie de les classer par catégorie. Par exemple, mes petites fonctions qui vont servir tout au long de mon programme, je vais les nommer de cette façon: TOOL_displaySmithChart ou encore TOOL_parametersInitialisation.
Si c'est une fonction d'export excel, ça sera alors EXCEL_templateLoadPullSheet; si tu as une multitude d'options d'affichage, alors une autre catégorie: DISPLAY_smithChart et DISPLAY_magnitudeSParameters, si tu as des fonctions de gestion de base de données: DBF_isInDB

Enfin, tu as compris le principe. Tu peux ensuite les classifier dans des dossiers, c'est un peu plus rapide ensuite pour rechercher le script de ta fonction.

Tu as remarqué que dans ma méthode, j'évite l'utilisation des underscores. Je les réserves pour les fonctions.

Pour les variables, en général je donne des noms assez simple, notamment lorsqu'elles sont utilisées de façon assez locale. Quand ta fonction est assez compact et bien pensée, que tu comprends immédiatement ce à quoi elle sert, inutile d'avoir un nom de variable trop compliqué. Si c'est une notion assez abstraite, alors un commentaire à sa première apparition pour mettre les choses au clair peut aider à y voir plus clair à la reprise du fichier.

Pour les variables que je "promène" dans une bonne partie du programme, je les regroupe fréquemment en structure pour les classer.

Voilà, je sais pas si ça va beaucoup t'aider, et encore plus important, je ne sais pas si c'est vraiment comme cela qu'il faut faire, mais au moins il y a une certaine logique dans ce que je fais qui me permet de m'y retrouver mieux qu'à mes débuts.

=> Améliorez vos développements avec le « MATLAB Style Guidelines 2.0 » :mrgreen: