[JAVA] convention de dénomination des méthodes booléennes

convention de dénomination des méthodes booléennes

Résumé

・ Modèles utilisables -> est + adjectif, a + partie passée, triade verbe courant + nom, verbe auxiliaire + verbe ・ Anti-pattern-> Oui et Non ne sont pas des noms clairs ・ Lorsque vous souhaitez décrire le sujet, exceptionnellement le sujet + la triade

Liste des règles de dénomination

is + adjectif

Demandez s'il est à l'état adjectif ex) isEnabled

a + partie passée

Demandez si vous êtes dans un état verbal ex) hasSent

3 verbe simple + nom

Demandez s'il y a une nomenclature dans l'état du verbe Peut être omis si la nomenclature est claire ex) hasError

Verbe auxiliaire + verbe

Demandez si c'est possible et si cela devrait être ex) canRemoveItems ex) shouldContinue

Ajouté le 21 février 2019 Existe-t-il un verbe auxiliaire? Aucun? J'ai reçu le commentaire. Je vois souvent des booléens qui utilisent des verbes auxiliaires, et je pense qu'ils s'appliquent également à la règle générale de commencer par un verbe. Par conséquent, je l'ai ajouté.

Erreurs courantes

Oui et non ne sont pas clairs

ex) checkValid

Erreur littéraire (non conforme aux conventions de dénomination)

ex) isEnable, existError → Est correctement activé, existeErreur

Quand tu veux écrire le sujet

Par exemple, lorsque j'ai essayé d'exprimer si un utilisateur existe avec boolean, j'ai trouvé l'expression suivante dans GitLab.

public boolean userExists

public boolean isUserExists

public boolean existsUser

J'aime le plus le premier motif. Quand j'essaye de l'exprimer en anglais Si l'utilisateur existe, ... parce que. Puisqu'il y a une règle pour commencer par un verbe en principe, il peut y avoir un deuxième ou un troisième modèle, mais cela semble étrange en tant que grammaire anglaise, donc je ne l'utilise pas beaucoup.

Il y a également eu une discussion sur les conventions de dénomination lorsque stackOverflow a un sujet. https://stackoverflow.com/questions/1566745/boolean-method-naming-readability

Même si vous regardez cela, il semble que userExists soit le plus.

De plus, si vous avez un objet appelé user, vous devez écrire user.exists ().

Recommended Posts

convention de dénomination des méthodes booléennes
[Rails] À propos des conventions de dénomination
Convention de dénomination des variables de collection