Es wird als Erfahrungszusammenfassung der Codekonvention beim Schreiben in Ruby geschrieben.
Sie müssen Ihren Code mit dem Ziel schreiben, den Code in kürzester Zeit vollständig lesen zu können, damit der Leser Änderungen vornehmen und Fehler finden kann.
Was Sie verstehen können, wenn Sie übersetzen, was die Variablen, Methoden und Klassen steuern
Variablen, Methoden, Klassen und Teile dieser Codes, die fast willkürlich geschrieben und definiert werden können, müssen sorgfältig geschrieben werden, um die obigen Codedefinitionen zu löschen. Um ehrlich zu sein, selbst wenn ich es absichtlich geschrieben habe, kann es irreführend sein. Es ist ärgerlich, weil es so aussieht, als würde ich nicht darüber nachdenken, es sei denn, ich eliminiere die Möglichkeit, so viel wie möglich falsch zu lesen.
Verwenden Sie einfache Verben, Nomenklaturen, Adjektive und Präfixe. Bei der Verwendung englischer Wörter ist es nicht erforderlich, nach der englischen Grammatik des Tickens zu schreiben, sondern es kann zu Verwirrung kommen, sodass die Situation auch so beurteilt werden kann, dass sie in der Regel innerhalb des Produkts oder Teams überzeugt. Du wirst es brauchen. Zum Beispiel von. Es gibt auch eine Möglichkeit, A von B in B von A zu übersetzen, anstatt A allein von B. Selbst wenn es egal ist, welches Sie verwenden, werden Sie gewarnt, wenn viele Personen mit A in B vertraut sind.
In verbalen Ausdrücken wird Grammatik oft im Sinne der Betonung ignoriert, und es ist eine Tatsache, dass selbst Ausländer nicht mit solcher Sorgfalt ausdrücken, sondern beim Codieren Auslandsverträge schreiben. Es scheint, dass Sie so schlau sein müssen, wie ein offizielles Dokument in diesem Bereich zu schreiben.
Wenn es ein Wort gibt, das berühmt dafür ist, als Substantiv verwendet zu werden, aber auch als Adjektiv verwendet werden kann, ist es möglicherweise ein Warnziel, wenn es verwendet wird. Zum Beispiel Produktkosten. Kurz gesagt, es stützt sich auf viele empirische Dinge, die bekannt oder unbekannt sind.
Vergangene Teilverben werden auch mit früheren Verben verwechselt und sollten vermieden werden. Problematische partizipative Wörter beim Lesen von Text müssen ebenfalls kontextabhängig beurteilt werden und sollten als Ausdrücke vermieden werden. Es scheint besser, keine Grammatiken zu verwenden, die eine kontextbezogene Beurteilung erfordern. Aufgrund der Art dieser Syntax sind relationale Synonyme grammatikalisch lange Grammatiken und werden nicht verwendet. Obwohl es viele Möglichkeiten gibt, zu beurteilen, wann sich jede Grammatik überschneidet, scheint es notwendig zu sein, alle Ausdrücke zu vermeiden, die beim Codieren dem Kontext überlassen bleiben und Ausdrücke erfordern, bei denen Informationen so kurz wie möglich eingefügt werden müssen.
――Wenn Sie Verben verwenden, müssen Sie die fünf Satzmuster kennen. Achten Sie daher auf die ordnungsgemäße Verwendung von automatischen und anderen Verben.
Bisher ist das alles, was mich interessiert.
Beispielsweise kann der registrierte Benutzer mit dem Variablennamen Benutzer sein. Dies liegt daran, dass es klar ist, dass sie registriert sind, wenn sie in die Datenbank eintreten.
Das Erstellen einer Variablen mit einer einzigen Nase kann für den Leser irreführend sein, wenn der Code wächst. Wenn es beispielsweise Variablen gibt, die hier und da nur Daten enthalten, ist das Lesen schwierig.
Das überzeugt. Ich weiß nicht, ob get_user_data gud oder so ist ...
Es ist der Code, der die Verarbeitung durchführt, daher ist es am besten, Verben zu verwenden.
Beachten Sie, was die Klasse steuert und in was die Variablen gespeichert sind
Der Code ist kein Satz, daher ist es besser, ihn nicht zu paraphrasieren. Ich neige dazu, es so zu tun, als würde ich einen Satz schreiben. Verwenden Sie keine Dinge, die fast dieselbe Bedeutung haben, wie z. B. Memmber = Benutzer, sondern vereinen Sie Dinge, die dieselbe Bedeutung haben, mit demselben Wort.
Die ungarische Notation, eine Benennungsmethode, die Informationen wie Typen und Bereiche in Variablennamen und Klassennamen einfügt, ist derzeit veraltet und scheint in vielen Fällen ein Anti-Muster zu sein. Im Fall eines Arrays sollten Sie beispielsweise vermeiden, es zu einer Variablen wie arr_data zu machen.