Jeu Vidéo 3

Nomenclature

Règles à suivre pour bien nommer les identificateurs présents dans un code C#/Unity.

Trois styles de notations seront à utiliser dans vos codes:

La notation chameau (camelCase) → Les mots qui composent un nom débutent par une majuscule, sauf le tout premier.
Exemples: pointageFinal, saisieNomUsager, nbEssais, etc.
La notation Pascal (PascalCase) → Les mots qui composent un nom débutent tous par une majuscule y compris le tout premier.
Exemples: AugmenterPointage(), EffacerInfo(), Recommencer(), etc.
La notation screaming snake (SCREAMING_SNAKE_CASE) → Les mots qui composent un nom sont tous en majuscules et séparés par un caractère de soulignement.
Exemples: NOMBRE_PI, POINTAGE_MAX, LIMITE_ECRAN_DROITE, etc.

Les règles suivantes sont en vigueur dans ce cours. Elles sont basées sur des pratiques courantes en C#, mais également dans d'autres langages (notamment en Java et JavaScript).

Élément	Nomenclature	Exemples
Variable locale / paramètre de fonction	notation chameau	string nomPerso, int nbVies, ptBonus, ageUsager, nbLaserJoueur
Classe	notation Pascal	GameManager, TankEnnemi, Perso
Méthode / fonction	notation Pascal	AugmenterPoints(), EffacerInfo(), Exploser()
Champ (field) privé ou public	notation chameau avec préfixe de soulignement (underscore)	_vitesse, _pointsVie, _pointage, _screenWidth
Constante	notation screaming snake	TAUX_TAXE, PI, POINTAGE_MAX, INFO_FINALE
Enums	notation Pascal (type et valeur)	Mois.Avril, JourSemaine.Vendredi, Niveau.Donjon
Propriétés (get/set)	même nom que le champ accédé mais sans soulignement au début	vitesse, pointsVie, pointage, screenWidth

Bonnes pratiques

Règles supplémentaires à suivre pour les identificateurs:

Évitez les noms trop longs, trop courts ou peu significatifs
N'utilisez que des lettres de l'alphabet sans accents, des chiffres et le soulignement (underscore)
N'utilisez jamais 2 soulignements consécutifs
Ne débutez jamais un identificateur par un chiffre
Suggèrez une action pour un nom de fonction/méthode (typiquement avec un verbe): Attaquer(), Imprimer(), AfficherPts()
N'utilisez pas des mots clefs du langage de programmation comme identificateur. Exemple: Les mots List ou Update sont réservés par le langage de programmation en C#/Unity. Si vous donnez ces noms à une variable ou une méthode, vous causerez certainement une erreur de syntaxe!
Abreviations: À éviter, sauf si elles sont très facilement reconnaissables par la majorité des "lecteurs" de votre code.
Quelques exemples fréquents et acceptés:
- nb → nombre
- pt → point
- rand → random
- anim → animation
- str → string
- txt → texte
- snd → sound
- cpt → compteur
- max → maximum
- min → minimum