[JAVA] Namenskonvention für boolesche Methoden

Namenskonvention für boolesche Methoden

Zusammenfassung

・ Muster, das verwendet werden kann-> ist + Adjektiv, hat + letzten Teil, Triade aktuelles Verb + Nase, Hilfsverb + Verb ・ Anti-Pattern-> Ja und Nein sind nicht eindeutig benannt ・ Wenn Sie das Thema beschreiben möchten, ausnahmsweise das Thema + Triade

Liste der Namensregeln

ist + Adjektiv

Fragen Sie, ob es sich im Adjektivzustand befindet ex) isEnabled

hat + letzten Teil

Fragen Sie, ob Sie sich in einem Verbzustand befinden ex) hasSent

3 einfaches Verb + Nomen

Fragen Sie, ob es im Verbzustand eine Nomenklatur gibt Kann weggelassen werden, wenn die Nomenklatur klar ist ex) hasError

Hilfsverb + Verb

Fragen Sie, ob es möglich ist und ob es sein sollte ex) canRemoveItems ex) shouldContinue

Hinzugefügt am 21. Februar 2019 Gibt es ein Hilfsverb? Keiner? Ich habe den Kommentar erhalten. Ich sehe oft Boolesche Werte mit Hilfsverben, und ich denke, dies gilt auch für die allgemeine Regel, mit einem Verb zu beginnen. Deshalb habe ich es hinzugefügt.

Häufige Fehler

Ja und Nein sind unklar

ex) checkValid

Literarischer Fehler (nicht im Einklang mit Namenskonventionen)

ex) isEnable, existError → Richtig ist aktiviert, existiert Fehler

Wenn Sie das Thema schreiben möchten

Als ich beispielsweise versuchte auszudrücken, ob ein Benutzer mit Boolean existiert, fand ich den folgenden Ausdruck in GitLab.

public boolean userExists

public boolean isUserExists

public boolean existsUser

Ich mag das erste Muster am meisten. Wenn ich versuche, es auf Englisch auszudrücken Wenn Benutzer existiert, ... weil. Da es im Prinzip eine Regel gibt, mit einem Verb zu beginnen, kann es ein zweites oder drittes Muster geben, aber als englische Grammatik erscheint es seltsam, so dass ich es nicht oft benutze.

Es gab auch eine Diskussion über Namenskonventionen, wenn stackOverflow ein Thema hat. https://stackoverflow.com/questions/1566745/boolean-method-naming-readability

Selbst wenn Sie sich das ansehen, scheint es, dass userExists am meisten ist.

Wenn Sie ein Objekt namens user haben, sollten Sie user.exists () schreiben.

Recommended Posts

Namenskonvention für boolesche Methoden
[Rails] Informationen zu Namenskonventionen
Namenskonvention für Sammlungsvariablen