Ich möchte Code schreiben, den andere leicht verstehen können.
Haben boolesche Attribute wie hide_email
oder email_hidden
einen Konventionsstil?
Ich denke darüber nach:
is <attribute_name>
vervollständigen
is
, weil Ruby das ?
Suffix für "is" -Style-Methodennamen bevorzugt (siehe unten für mehr), so dass nur email_hidden
übrig bleibt.
Benennen Sie Ihr Attribut für Ihren speziellen Fall folgendermaßen:
email_is_hidden
. is
und Sie bleiben mit email_hidden
?
endet) Ihres booleschen Attributs und gibt true
/ false
wie erwartet zurück. Während Ihr Attribut in der Datenbank den Namen email_hidden
hat, sollten Sie es aus Gründen der Übersichtlichkeit als email_hidden?
in Ihrem Code verwenden, ebenso wie die Ruby on Rails-Konvention. Der Ruby-Code-Smile sagt, dass alle booleschen Methoden mit?
enden solltenBei aktivem Datensatz können Sie
sehen %Vor%Oder in Ruby finden Sie
%Vor%Wenn Sie über Konventionen von Ruby wissen wollen, lesen Sie dies
Nehmen Sie diese zwei Beispiele von Namen, die Sie gegeben haben:
hide_email
wäre ein guter Name für eine Methode, die eine solche Aufgabe ausführt, eine Methode, die alle Prozeduren ausführt, um eine E-Mail im Bereich Ihres Systems auszublenden. Aber es wäre nie ein guter Name für eine boolesche Methode, die den Status einer E-Mail zurückgibt. email_hidden?
, mit einem Fragezeichen (?) am Ende, wäre der korrekte Name für eine boolesche Methode, die angibt, ob die E-Mail versteckt ist oder nicht. Denken Sie immer an Ruby-Konventionen, wenn Sie wirklich guten Code schreiben wollen. Sie werden Ihnen helfen, auch wenn Sie über die Prozesse in Ihrem System nachdenken.
Tags und Links ruby attributes ruby-on-rails naming-conventions