Nommage des Variables et des Fonctions

Le nommage des variables et des fonctions est une composante essentielle de la documentation du code. Des noms clairs et significatifs facilitent la compréhension du code, la collaboration avec d'autres développeurs, et la maintenance à long terme.

Lors du choix de noms pour les variables et les fonctions, suivez ces bonnes pratiques :

• Clarté : Choisissez des noms clairs et explicites qui décrivent la signification ou le but de la variable ou de la fonction.

• Concision : Évitez des noms excessivement longs, mais ne sacrifiez pas la clarté pour la brièveté.

• Cohérence : Suivez des conventions de nommage cohérentes dans tout le code, de manière à ce que les noms aient un sens similaire pour des concepts similaires. Ces conventions doivent être mise en place à la base du projet avec votre équipe ou ce sera une convention donnée par votre chef là où vous travaillerez.

• Evitez les Abréviations Confuses : Si vous utilisez des abréviations, assurez-vous qu'elles sont largement compréhensibles et n'induisent pas en erreur.

• Utilisez des Noms en Anglais : Dans la mesure du possible, utilisez des noms en anglais pour les variables et les fonctions, car c'est une convention largement acceptée dans la programmation.

Dans de nombreux langages de programmation, il existe des conventions de nommage recommandées. Voici quelques-unes de ces conventions pour les noms de variables et de fonctions :

• Camel Case : Les noms de variables commencent par une lettre minuscule, et les mots suivants commencent par une majuscule (par exemple, maVariable). Lors d'utilisation de variable locale, on va placer un trait de soulignement (_) avant le nom de la variable, comme _maVariableLocale

• Snake Case : Les mots sont séparés par des traits de soulignement en minuscules (par exemple, ma_variable, ma_fonction()). Cette convention est couramment utilisée en Python, nous ne l'utiliserons pas, à part pour remplacer des espaces dans vos nom de fichier si le vous le souhaitez et surtout, nous utiliserons ce signe pour commencer le nom d'une variable locale (Mon_Nom_De_Fichier,_maVarLocale), pour le reste, vous oubliez.

• Pascal Case : Les noms commencent par une majuscule, et les mots suivants commencent également par des majuscules (par exemple MaFonction()). Cette convention est couramment utilisée pour nommer les fonctions et les classes pour ma part, pour Microsoft et dans certains langages de programmation.

• Kebab Case : Les mots sont séparés par des traits d'union en minuscules (par exemple, ma-variable, ma-fonction()). Jamais vu, jamais utilisé, mais sachez que ça existe. Je ne veux pas voir ça à mon cours non plus.

Le choix de noms significatifs est essentiel pour la compréhension du code. Évitez les noms génériques tels que a, x, ou foo. Au lieu de cela, choisissez des noms qui décrivent le rôle ou la signification de la variable ou de la fonction.

Exemple en de ma manière d'écrire :

int totalScore;
void CalculateTotalScore() {
    // ...
}
Copy

Exemple en Snake Case (Python) :

total_score = 0
def calculate_total_score():
    # ...
Copy

Le nom totalScore est plus significatif que score, car il indique que c'est le score total. De même, CalculateTotalScore est plus expressif que calculate seul.

En résumé, le choix de noms appropriés pour les variables et les fonctions est essentiel pour la lisibilité et la maintenabilité du code. Suivez les conventions de nommage appropriées à votre langage de programmation et privilégiez la clarté et la signification des noms.

#cours #blindcode #algo #cours #code #blindcode

créé le 2023-10-16 à 13:43