Was ist besser? nNodes oder nodeCountBenennung einer Zählvariablen
Antwort
Die zweite, da es richtig liest.
Dies ist einfach ein Stilproblem. Ich bevorzuge nodeCount
, weil ich es klarer finde. nNodes
ist der ungarischen Notation ähnlicher, sagt aber nicht, dass es sich um eine Zählvariable handelt.
Welches auch immer mit dem Rest Ihres Code-Base/style guide/dev-Teams übereinstimmt.
Es hängt wirklich von den akzeptierten Namenskonventionen der Sprache ab, die Sie verwenden, aber nodeCount
ist besser lesbar. Wenn Sie Java verwenden, können Sie den Leitfaden Java Naming Conventions verwenden.
Die erste in C++, die zweite in C#/Java.
Obwohl dies wirklich sehr subjektive Frage ist und sollte von Ihrem Team/Unternehmen Richtlinien beantwortet werden.
numNodes?
Mögliche Namen:
- Zählung
- Größe
- Länge
Es hängt davon ab, aber ich würde die zweite (nodeCount
) wählen. Wenn Ihr Projekt eine spezielle Konvention definiert hat, sollten Sie dieser Konvention folgen oder die Vereinbarung mit Ihrem Team besprechen. Es könnte auch von der Domäne Ihrer Anwendung abhängen. Es kann in Ordnung sein, allgemein akzeptierten Notationen in Ihrer Domain zu folgen.
Es gibt einige Regeln, die Ihnen helfen könnten, solche Entscheidungen zu treffen.
Wenn etwas missverstanden werden könnte, wird es von jemandem missverstanden. Beseitigen Sie die Möglichkeit von Missverständnissen. Die Wahrscheinlichkeit von Missverständnissen ist viel weniger im zweiten Vorschlag nodeCount
. Jeder, der Englisch spricht, sollte es verstehen. Der erste Vorschlag auf der anderen Seite hängt vom Verständnis des Präfixes n ab.
Schreiben Sie das beste beschreibende Substantiv am Ende. Ist es mehr ein zählen oder mehr eine Sammlung von Knoten? Für die weitere Verwendung der Variablen ist es wichtiger zu verstehen, dass es sich um eine Zählung (eine Zahl) handelt, was dann gezählt wird. Daher ist nNodes
schlechter als nodeCount
.
Folgen Sie grundlegenden Programmierprinzipien wie KISS (Keep it simple, doof) oder "Schreiben Sie keinen cleveren Code. Schreiben Sie" peinlich offensichtlichen "Code." Fragen Sie Ihre Mutter, ob sie Ihren Code versteht. Wenn sie das gemacht hat, dann hast du guten Code geschrieben :)
Wenn deine Code-Konvention ist, dass "nSomething" immer für "Anzahl von Somethings" steht, musst du nicht noch einmal sagen, dass es eine Zählvariable ist. – ShreevatsaR
Ja @ShreevatsaR, ich stimme Ihnen zu. Aber wenn es (noch) keine Konvention gibt, dann scheint nodeCount (für mich) klarer zu sein. –