Pour plus d'articles, veuillez suivre mon blog personnel : https://seven777777.github.io/myblog/
Avant-propos :
Nommez-vous les variables comme bon vous semble pendant le développement ?
En tant que programmeur avec près de quatre ou cinq ans d'expérience en codage, je dois souvent faire face à la dénomination de diverses classes, variables et fonctions au cours du processus de développement.
Bien que certaines règles de dénomination de style personnel se soient progressivement formées au fil des années, elles ne sont pas devenues un système relativement standardisé et sont donc encore plus informelles dans de nombreux cas.
J'ai récemment lu le chapitre sur le pouvoir des noms de variables dans "Code Encyclopedia 2", j'ai donc sélectionné quelques points de connaissances dans le livre et les ai répertoriés.
Je crois que pour les programmeurs ayant une certaine expérience, cela peut les aider à réexaminer leurs habitudes de codage quotidiennes et à corriger certaines mauvaises habitudes ; pour les programmeurs débutants, ils peuvent se réguler dès les premiers stades pour développer un bon style de codage.
Bref, c'est un article utile !
Choses à noter lors du choix de bons noms de variables
Un bon nom de variable est lisible, facile à retenir et approprié
Considérations relatives à la dénomination
Habituellement, la description de la variable est le meilleur nom de variable
Longueur de dénomination appropriée
Trop court pour transmettre suffisamment d'informations
Trop long, difficile à écrire et obscurcit la structure visuelle du programme
L'impact des noms de variables sur la portée
Les noms plus longs conviennent aux variables rarement utilisées ou aux variables globales.
Les noms plus courts conviennent aux variables locales ou aux variables de boucle
Cependant, en tant que stratégie de programmation défensive, les noms de variables courts doivent être évités autant que possible.
Qualifier les noms dans l'espace de noms global
Qualificateurs de valeur calculée dans les noms de variables
Pour certaines variables qui représentent les résultats du calcul : total, moyenne, maximum, etc., utilisez des qualificatifs similaires à : Total, Somme, Moyenne, Max, Min, Enregistrement, Chaîne, Pointeur, etc. pour modifier un certain nom. Le qualificatif doit être Le mot est ajouté à la fin du nom.
Tels que : revenueAverage, dépensesTotal
La cohérence améliore la lisibilité et simplifie la maintenance
Il existe des exceptions à la règle consistant à mettre les quantités calculées après leurs noms. La position du qualificatif Num est déjà conventionnelle. Num est placé au début du nom de la variable pour représenter un nombre total. Placé à la position finale représente un indice.
- NumCustomers - représente le nombre total d'employés
- customerCount - représente le nombre total d'employés
- customerIndex - représente un employé spécifique
Mots contrastés couramment utilisés dans les noms de variables
Améliorez la lisibilité en appliquant des conventions de dénomination pour améliorer la cohérence dans l'utilisation de mots contrastés.
- début/fin
- premier Dernier
- verrouillé/déverrouillé
- min max
- suivant précédent
- ancien nouveau
- ouvert/fermé
- visible/invisible
- cible Source
- source/destination
- haut/bas
Nommer des types de données spécifiques
indice de boucle
Noms conventionnels : i,j,k
Si la variable doit être utilisée en dehors de la boucle, elle doit recevoir un nom plus significatif.
Une dénomination soignée des variables d'index de boucle peut éviter le problème courant de diaphonie d'index : écrire i quand vous voulez dire j et j quand vous voulez dire i. Cela rend également l'accès aux données plus clair :
score[teamIndex][eventIndex] donne plus d'informations que score[i][j].
Variables d'état
Pour plus de clarté, les balises doivent se voir attribuer des valeurs à l'aide de types d'énumération, de constantes nommées ou de variables globales utilisées comme constantes nommées, et leurs valeurs doivent être comparées à ces quantités, par
ex.
mauvais:
if(printFlag == 16)
bien:
if(reportType == ReportType_Annual)
Variables temporaires
Température couramment utilisée
Mais vous pouvez également utiliser un nom plus descriptif.
variable booléenne
Noms de variables booléennes typiques
- fait signifie que quelque chose a été terminé
- erreur signifie qu'une erreur s'est produite
- trouvé signifie qu'une valeur a été trouvée
- success/ok indique si l'opération a réussi
Donnez des noms de variables booléennes qui impliquent un sens vrai/faux
Certains programmeurs (moi y compris) aiment préfixer les noms de variables booléennes avec is. L'un des avantages de cette approche est qu'elle ne fonctionne pas avec des noms obscurs : isStatus ?
L'un des inconvénients est que cela réduit la lisibilité des expressions logiques simples : if(isFound) est légèrement moins lisible que if(found)
Utiliser des noms de variables booléens positifs
Réduire l'utilisation des noms tels que : notFound, notDone...
sont particulièrement difficiles à lire, surtout lorsqu'ils sont niés
type d'énumération
Vous pouvez utiliser le préfixe de groupe, tel que Color_, Planet_ ou Month_ pour indiquer clairement que les membres de ce type appartiennent à un groupe.
constante
Lorsque vous nommez une constante, la chose abstraite doit être nommée en fonction de la signification représentée par la constante, plutôt que de la valeur numérique de la constante. .
Cinq = 6,0 est ridicule.
Convention de dénomination informelle
Lignes directrices pour les conventions de dénomination indépendantes de la langue
Distinguer les noms de variables et les noms de sous-programmes
Les noms de variables et d'objets commencent par une lettre minuscule
Les noms de sous-programmes commencent par une lettre majuscule
Distinguer les classes et les objets
Solution 1 : Distinguer les types et les variables en commençant par une majuscule
Widget widget
Solution 2 : distinguer les types et les variables en majuscules
WIDEGE widget
Option 3 : Distinguer les types et les variables en ajoutant le préfixe t_ au type
t_Widget widget
Option 4 : Distinguer les types et les variables en préfixant les variables avec "a"
Widget aWidget
Solution 5 : distinguer les types et les variables en utilisant des noms plus clairs pour les variables
Widget employeeWidget
- Identifie la variable globale g_
- Variable membre d'identité m_
- Déclaration de type d'identité t_
- Identifie la constante nommée c_
- Pour identifier les éléments de type énumération, ajoutez un préfixe de type spécifique ; tel que : color_
- Marquez les paramètres en lecture seule dans les langues où il n'est pas possible de garantir que les paramètres d'entrée sont en lecture seule.
- Dénomination du format pour améliorer la lisibilité
Deux méthodes courantes : casse et délimiteurs
Directives générales pour les abréviations
- Abréviations standard (abréviations courantes répertoriées dans les dictionnaires)
- Supprimer toutes les voyelles non frontales (ordinateur-> cmptr)
- Supprimez les mots de fonction et, ou, le, etc.
- Utilisez la première ou les premières lettres de chaque mot
- Tronquer uniformément après la première, la deuxième ou la troisième lettre (choisissez la plus appropriée) de chaque mot
- Conservez la première et la dernière lettre de chaque mot
- Utilisez tous les mots importants du nom, pas plus de trois
- Supprimez les suffixes inutiles ing, ed, etc.
- Conserver la prononciation la plus remarquable de chaque syllabe
- Assurez-vous de ne pas changer la signification de la variable
- Utilisez les techniques ci-dessus à plusieurs reprises jusqu'à ce que la longueur de chaque nom de variable soit réduite à 8 à 20 caractères ou jusqu'à ce que la limite de caractères pour les noms de variables dans la langue soit atteinte.
noms à éviter
- Évitez d'utiliser des noms ou des abréviations trompeurs
- Évitez d'utiliser des noms ayant des significations similaires
- Évitez d'utiliser des variables avec des noms similaires qui ont des significations différentes
- Évitez d'utiliser des noms qui se ressemblent
- Évitez d'utiliser des chiffres dans les noms
- Évitez les fautes d'orthographe dans les noms
- Évitez les mots souvent mal orthographiés en anglais : Absense, acummulate, acsend…
- Ne distinguez pas les noms de variables uniquement par casse
- Évitez d'utiliser plusieurs langues naturelles
- Évitez d'utiliser des noms de types, de variables et de sous-programmes standard
- N'utilisez pas de noms qui n'ont rien à voir avec la signification de la variable
- Évitez les noms contenant des caractères prêtant à confusion qui rendent difficile la distinction entre les paires :
- Chiffre 1 et lettre minuscule l
- Chiffre 1 et lettre majuscule L
- .et,
- Zéro 0 et lettre majuscule O
- 2 et Z
- :et;
- S et 5
- G et 6
