Conventions de nommage des fonctions
j'écris une bibliothèque, donc je veux que ses fonctions soient nommées aussi clairement et intelligemment que possible. Actuellement, j'utilise les principes suivants:
- Noms qui s'expliquent par eux - mêmes: a la fonction getName () indiquera développeur ce qu'il retourne ainsi que setAddress(), isMale (), etc.
- Manches: un nom de fonction doit être comme aussi court que possible pour qu'il soit simple à taper et facile à rappeler. Fonction getNumberOfPagesInTheBook () n'est pas bon, quelque chose de comme getBookPageCount () est mieux.
- utilisation des préfixes: j'utilise toujours les préfixes dans les fonctions telles que getName (), setName (), hasHair(), isBlond (), etc.
je veux savoir s'il y a quelque chose que je manque. Aussi, pouvez-vous penser à d'autres préfixes que is, has, get et set?
7 réponses
une des règles les plus universelles, mais simples est: les noms de fonction devraient être des verbes si la fonction change l'état du programme, et les noms s'ils sont utilisés pour retourner une certaine valeur.
une chose plus importante à faire en écrivant une bibliothèque est d'utiliser le même mot pour décrire la même action à chaque fois. ne pas écrire une fonction nommée getName dans une classe et une autre fonction nommée retrieveNumber dans une autre classe.
les Autres préfixes? Peut-être" isa", bien que cela ne soit applicable que dans certaines situations.
certaines langues peuvent communiquer " get "et/ou" set " avec d'autres constructions (en particulier, dans le Lisp commun vous pouvez faire (setf (get* ...) bla) faire la même chose que ce que vous auriez voulu (* ... bla)).