fr:devmon:guidelines:variables
Table des matières
Nom de variable
En général
- Évitez CamelCase et ses variantes : utilisez underscore
- Aussi court que possible pour décrire la “fonction” de la variable : par exemple, my $desc = “devmon est cool”
Avec ou sans "s" à la fin
- scalaire($) et hachage(%) sans “s”
- tableau(@) avec un “s”
Évitez les noms ambigus
- last (dernier ou précédent)
- set (ajuster ou collection)
- left (direction ou ce qui reste)
- right (direction, correct ou droit)
- no (négatif : non ou nombre)
- record (verbe ou nom)
- second (temps ou position)
- close (à proximité ou fermé)
- use (utilisation active ou catégorie de fonction)
- term (terminal ou terminaison)
- temp (température ou temporaire)
- val (valeur ou valide)
- Évitez les noms trop courts qui ne procurent pas un réel avantage : préférez une bonne lisibilité
- prop(erty), val(ue), str(ing), num(ber), idx(index), mais utilisez-les comme postfixe {variable}_XXX
- i, j, k, x, y, z
Ne pas utiliser
- list, set, value, equals, data, var,
Quantité
- scalaire : {variable}_count
- tableau : {variable}s_count (pas de double “s” bien sûr !)
- hachage : {variable}_count
- Structure linéaire, hachage, liste → {variable}_count ?
- Structure non linéaire : arbre, ensemble : → {variable}_count, ?
Préfixe
- format : as_number, as_string,
- booléen : is_number
Référence
- {variable}_ref
Quantité
fr/devmon/guidelines/variables.txt · Dernière modification : 2024/05/11 17:01 de adminw1k1