Convention de Nommage des Variables
Écrit par Fabien Bodard
C'est simplement la façon dont vous nommez vos variables ! En d' autres termes, la méthode utilisée pour différencier deux types de variables ou deux types d' objets.
Vous devez adopter une convention.
Si vous appelez chaque variable selon l’humeur du moment, non seulement vous vous retrouverez avec des noms dont vous ne vous souviendrez plus, mais vous allez rechercher des noms de variables astucieux au lieu de rechercher des algorithmes judicieux. Une convention de nommage doit être un réflexe. En fait, deux personnes qui utilisent la même convention de nommage obtiennent le même nom de variable.
La plupart du temps, une mauvaise convention de nommage va de pair avec un mauvais code.
Gambas donne systématiquement un nom par défaut aux widgets, comme Button1, TextBox1, etc... Puis incrémente cette valeur lorsque vous ajoutez un nouveau composant depuis l' IDE. Mais le problème avec ce système c’est que votre code est vraiment complexe à interpréter ou déboguer.
Mais tout n' est pas perdu... J'ai peut-être une solution pour vous :-)
La convention hongroise pour Gambas
La convention hongroise est bonne. Vous l'avez probablement déjà rencontrée dans les sources des exemples de Microsoft Visual Basic. Je ne dis pas que c' est la meilleure, mais je l'ai utilisée pour d'autres langages comme PHP, Fortran, et elle va bien avec Gambas.
Tous les adeptes de la convention hongroise que je connais, l'ont détestée au début. Mais quelle que soit votre opinion, vous ne regretterez pas d' avoir appris à lire hongrois.
Cette convention a été créée par Charle Simonyi, vétéran du développement chez Microsoft, et natif de Hongrie.
Elle implique d'identifier les variables en deux parties : une partie basique composée de lettres en minuscules indiquant le type de variable, et un qualifiant ayant sa première lettre en majuscule, ce qui distingue une variable des autres de même type. Vous pouvez ajouter aussi une lettre de début comme
$ pour différencier les variables globales.
Exemples
Une variable de type Entier qui sera utilisée pour localiser quelque chose
iPos
Une variable de type Entier qui sera utilisée pour localiser quelque chose dans un fichier et une autre dans un textarea
iFilePos
iLinePos
Un formulaire pour enregistrer un fichier sous...
frmSaveFileAs
Convention sur le préfixe pour les types communs de variables
|
Type de variable
|
Préfixe
|
|---|
|
Integer
|
i
|
|
Float
|
f
|
|
booléen
|
b
|
|
octet
|
bt
|
|
Short
|
sh
|
|
Long
|
l
|
|
Single
|
sng
|
|
Variant
|
v
|
|
Pointer
|
ptr
|
|
String
|
s
|
|
Date
|
date
|
|
Object
|
o
|
Convention sur le préfixe pour un type de données tableau ou collection
|
Type de variable
|
Préfixe
|
|---|
|
Static array
|
ar + préfixe du type
|
|
Integer[]
|
ari
|
|
Float[]
|
arf
|
|
Booléen][]
|
arb
|
|
Octet][]
|
arbt
|
|
Short[]
|
arsh
|
|
Long[]
|
arl
|
|
Single[]
|
arsng
|
|
Variant[]
|
arv
|
|
Chaîne[]
|
ars
|
|
Date[]
|
ardate
|
|
Object[]
|
aro
|
|
Collection
|
col
|
Types Spéciaux
Exemples de préfixes de composant