Nomme une fonction
Choisir de bons noms de fonctions fait partie intégrante de l'écriture de code de qualité.
Garde en tête les recommandations suivantes quand tu nommes une fonction.
Choisis des noms de fonctions parlants
Quand on nomme une fonction, on doit savoir clairement ce qu'elle fait.
Par exemple, la fonction get(studentId, subject) porte un nom peu parlant, et on ne voit donc pas clairement ce qu'elle fait.
Elle peut aussi bien récupérer la note d'un élève dans une matière que son statut d'inscription.
Un meilleur nom serait getStudentGrade(studentId, subject), car il indique précisément ce que fait la fonction.
Ne fais pas un nom de fonction trop long
Veille à ne pas donner un nom trop long à une fonction.
Par exemple, checkStudentFailOrPassOrMeritOrDistinction(mark) est un nom de fonction inutilement long.
Plus un nom est long, plus il est difficile à mémoriser et plus il occupe de place à l'écran.
Ne fais pas un nom de fonction trop court
À l'inverse, un nom trop court peut aussi perdre les personnes qui lisent le code.
Par exemple, checkFPMD(mark) est un mauvais nom de fonction, car on ne voit pas immédiatement ce que « FPMD » signifie.
Utilise un nom que tout le monde comprend
Le nom de ta fonction doit être compréhensible par toute personne qui lit le code.
Par exemple, un nom de fonction obscur comme DeathStar() peut t'amuser, mais il n'indique pas sa finalité et risque de perdre les autres développeurs qui lisent le code.
Choisis une seule convention pour nommer les opérations
Tiens-toi à une seule convention pour nommer les opérations qui font la même chose.
Par exemple, si tu nommes getStudentName() la fonction qui récupère le nom d'un élève, n'utilise pas un autre verbe pour la fonction qui récupère sa note (par exemple retrieveStudentGrade()).
Évite d'utiliser le même mot pour deux choses
Par exemple, n'utilise pas add pour insérer un ensemble d'éléments dans une collection si tu as déjà employé ce mot pour l'addition de deux nombres.
Utilise plutôt insert ou append.
