Sind Kurzbezeichnungen schlecht? [geschlossen]

Sind Kurzbezeichnungen schlecht? Wie korreliert die Länge des Bezeichners mit dem Codeverständnis? Welche anderen Faktoren (neben dem Codeverständnis) könnten bei der Benennung von Bezeichnern eine Rolle spielen?

Nur um zu versuchen , die Qualität der Antworten zu halten, beachten Sie bitte , dass es einige der Forschung zu diesem Thema bereits!

Bearbeiten

Neugierig, dass jeder der Meinung ist, dass die Länge nicht relevant ist oder größere Bezeichner bevorzugt, wenn beide von mir angegebenen Links auf schädliche Bezeichner hinweisen!

Defekter Link

Der Link unten zeigte auf eine Recherche zu diesem Thema, aber es ist jetzt kaputt. Ich habe anscheinend keine Kopie des Papiers bei mir und kann mich nicht erinnern, was es war. Ich lasse es hier für den Fall, dass jemand anderes es herausfindet.

• http://evergreen.loyola.edu/chm/www/Papers/SCP2009.pdf

Die beste "Regel", die ich gehört habe, ist, dass die Namenslängen proportional zur Länge des Bereichs der Variablen sein sollten. Ein Index iist also in Ordnung, wenn der Körper der Schleife ein paar Zeilen lang ist, aber ich verwende gerne etwas Beschreibenderes, wenn er länger als 15 Zeilen wird.

Jede Variable sollte eine Bedeutung haben und ihr Name ist Teil dieser Bedeutung. Und ein sehr wichtiger Teil, da er dem Leser hilft, zu verstehen, wofür er da ist, ohne tiefer in den Algorithmus einzusteigen. i, jsind offensichtlich als Indizes zu verwenden, sie sind kurz, aber sehr informativ. bntist hässlich closeoder closeButtonsinnvoll. Kurz oder lang zu sein, ist also nicht das wichtigste Kriterium für den Variablennamen, es sollte aussagekräftig sein. Die Aussagekraft hängt stark vom Kontext ab. Sie können beispielsweise nder lokalen Zeichenfolgenvariablen einen sehr kurzen Namen geben , der in einem kleinen Codeblock mit beispielsweise 10 Zeilen verwendet wird und sich auf den Namen einer Eigenschaft bezieht ( vdenn value ist ein anderes Beispiel).

So Variablennamen sollten informativ sein und es spielt keine Rolle , sie kurz oder lang .

Ich werde einen Bezeichner verwenden, der die Variable unabhängig von der Länge beschreibt.

Die Fälle von i, j und k sind an sich so allgegenwärtig, dass sie sich selbst beschreiben. Sie wissen automatisch, dass es sich um Schleifenindizes handelt. Das gleiche könnte man auch sagen für:

foreach loop (Strings s : myString)

Allerdings bieten IDEs jetzt Tools zur Code-Vervollständigung, sodass der einzige negative Nebeneffekt von sehr langen und beschreibenden Bezeichnern entfernt wurde.

Gerne füge ich einem Bezeichner ein zusätzliches Wort hinzu, wenn dies erforderlich ist, um den Zweck der Variablen zu erläutern.

Sie sind nicht so schlecht wie die irreführenden Kennungen. Es macht mir nichts aus, Code zu debuggen, bei dem die Bezeichner nur ein Buchstabe sind, aber in dem Moment, in dem unterschiedliche Namenskonventionen in das Bild kommen, wird es ärgerlich. Wenn Sie z. B. irgendwo sehen strPersonIDund dann woanders s_EmployeeID, ist es verwirrend zu sagen, ob es sich um diese beiden Zeichenfolgen handelt und ob es einen Unterschied gibt. Auch wenn die Variablen kopiert ( pmapIntString = new std::map<int,int>) und völlig falsch sind, mache ich mir Sorgen.

Wenn es um mich geht, füge ich dem Code Kommentare für die verwendeten wichtigen Variablen hinzu und versuche, den in der Entwicklungsrichtlinie angegebenen Standard beizubehalten. Wenn es keinen Standard gibt, versuche ich, die gleiche Namenskonvention im gesamten Code beizubehalten.

Ich habe Probleme...

Ich benutze immer beschreibende Namen als Bezeichner, aber in letzter Zeit habe ich sehr kurze Bezeichner verwendet.

Ich denke, es hängt vom Kontext des Codes ab:

• Wenn Sie komplexe Funktionen (Algorithmen) schreiben, verwenden Sie IMMER kurze Bezeichner (einzelne Zeichen sind am besten).
• Verwenden Sie beim Schreiben von Parameterwerten für Funktionen beschreibende Namen.

Ich denke, es hängt auch davon ab, wie dicht der Code ist. Manchmal ist es schwieriger zu lesen, wenn man Namen hat.

Manchmal ohne Namen ist es total kryptisch!

Ich denke, dass sie an sich nicht schlecht sind, aber sie sind nicht informativ, es sei denn, sie sind sehr standardisiert.

Daher sind die Schleifenvariablen i, j und k so üblich, dass es keinen Grund gibt, sie nicht zu verwenden, wenn Sie eine indizierte Schleife erstellen.

Die andere Stelle, an der ich einen sehr kurzen Bezeichner verwende, ist die Deklaration einer temporären Variablen, die in wenigen Zeilen den Gültigkeitsbereich verlässt - beispielsweise die temporäre Variable aus einer foreach-Schleife. Wenn nicht auf irgendwo anders verwiesen wird, kann jeder, der den Code liest, die Deklaration leicht einsehen und nachvollziehen, wofür sie verwendet wird. Wenn es jedoch für mehr als fünf oder sechs Zeilen verwendet wird, werde ich versuchen, ihm einen klareren Namen zu geben.

Darüber hinaus versuche ich, informative Längenkennungen zu verwenden - insbesondere auf Klassenebene möchte ich eine Kennung, die Sie lesen können, um eine Vorstellung davon zu bekommen, wozu die Variable dient. Wenn sie zu lang werden (und ich sehe manchmal Code mit vier oder fünf Wörtern, die als Bezeichner aneinandergereiht sind), neige ich dazu, das als Codegeruch zu betrachten. Wenn ich so viel Text zur Unterscheidung meiner Variablen benötige, sind sie tatsächlich eine Gruppe, könnte besser in einer Hashmap oder Liste gespeichert werden? Könnte ich ein Objekt erstellen, um diese Daten genauer zu modellieren? Manchmal kann man das nicht, aber ein sehr langer Bezeichner ist ein Indikator dafür, dass es sich hier um etwas handelt, das es wert ist, angeschaut zu werden.

Ich stimme den anderen Antworten hier sehr zu, möchte jedoch auf einen weiteren Faktor hinweisen, der meiner Meinung nach häufig übersehen wird. Ein guter Name ist oft ein Name, der für den Code typisch ist. Dies kann auf Sprachebene, Algorithmusebene oder einigen internen Redewendungen für die vorliegende Codebasis erfolgen. Der Punkt ist, dass der Name zwar für jemanden, der die Domäne des Codes nicht kennt, nichts bedeutet, aber dennoch der beste Name im gegebenen Kontext sein kann.

Die Benennung einer Variablen ist immer eine Übung, um Eindeutigkeit und Verständlichkeit in Einklang zu bringen. Die Länge des Namens hängt auf unterschiedliche Weise mit beiden zusammen. Längere Namen lassen sich leichter eindeutig machen. Namen mittlerer Länge sind in der Regel verständlicher als zu kurze oder zu lange Namen.

Eine sehr kurze Variablennamen ist nur sinnvoll , wenn es eine Geschichte hat , die es verständlich macht ( zum Beispiel i, j& kfür Indizes, dxfür einen Abstand entlang einer Achse) oder einem Rahmen, der klein genug für alle Referenzen zu sein auf einmal sichtbar (zB , temp). Die schlimmsten Variablennamen der Welt sind solche t47. ("Was bedeutet das und warum unterscheidet es sich von t46?") Gott sei Dank ging dieser Namensstil meistens mit FORTRAN aus, aber hier wurzelt der Wunsch nach längeren Variablennamen.

Wie Ihre Originalarbeit gezeigt hat, sind auch zu lange Namen schwer zu lesen, da beim Betrachten des Codes subtile interne Unterschiede übersehen werden können. (Der Unterschied zwischen DistanceBetweenXAxisAbscissae& DistanceBetweenYAxisAbscissaeist wirklich schwer zu erkennen.)

Wie NoteToSelf bereits erwähnt hat, hängen die Anforderungen an die Eindeutigkeit eines Namens in erster Linie vom Umfang ab, über den der Name eindeutig sein muss. Der Index einer 5-Zeilen-Schleife kann sein i; Ein Index eines aktiven Datensatzes, der von Funktion zu Funktion weitergegeben wird, sollte einen aussagekräftigeren Namen haben.

Eine Variable lokal zu einer Funktion kann einen kleinen beschreibenden Namen haben, wie deltaXohne Problem. Eine statische Delta-X-Variable in einem Modul muss einen Namen haben, der dieses DeltaX von anderen DeltaX-Variablen im selben Modul unterscheidet, wodurch es länger wird. Und eine globale Delta X-Variable muss für alle Module und alle möglichen anderen Module, die erstellt werden können, eindeutig sein, möglicherweise durch Verketten des Modulnamens mit dem anderen beschreibenden Namen. Dies ist eines der vielen Probleme mit Globals; um sinnvoll eindeutig zu sein, müssen die Namen lang genug sein, um sie schwer lesbar zu machen.

Im Gegenteil, ich denke, lange Bezeichner sind schlechter als kurze Bezeichner (es sei denn, Sie haben es mit Konstanten zu tun). Durch TheVariableThatHoldsTheCapacityOfMyContainerClassdie Verwendung von wird Ihr Code wesentlich fehleranfälliger als durch die Verwendung von Capacity.

An und für sich sind Kurzbezeichnungen nicht schlecht. Der Zweck der Auswahl guter Namen (kurz oder lang) dient der Code-Klarheit. Die Auswahl von Kennungen im Dienste der Code-Klarheit ist wichtiger als die Einhaltung einer Mindestlängenanforderung. Im Allgemeinen bedeutet dies, etwas längere aussagekräftige Namen zu schreiben.

Eine Beobachtung, die ich im Laufe der Jahre gemacht habe und die heute weniger ist als vor 10 oder 15 Jahren. Programmierer, die nicht tippen können, sind diejenigen, die sich über die Benennung von Variablen hinwegsetzen. Sie sind diejenigen mit allen 1-3 Buchstaben Variablennamen.

Mein Rat ist also, einen aussagekräftigen Namen zu verwenden, wie viele Kommentatoren gesagt haben, und dann das Tippen zu lernen. Ich habe darüber nachgedacht, Interviews mit einem Tipptest zu versehen, nur um zu sehen, wo sich die Leute befinden, aber ich beginne, viel weniger Nicht-Tipper zu sehen, da Computer ein größerer Teil der Gesellschaft werden.

Das erste Papier, auf das Sie verlinken, sieht interessant aus, aber die Schlussfolgerung lautet, dass sie keinen signifikanten Beweis für oder gegen die Hypothese gefunden haben, dass "Erdungshinweise", einschließlich aussagekräftiger Variablennamen, beim Codeverständnis helfen. Der verwendete Blick verweilt als Proxy für das Codeverständnis, was interessant ist, aber kein Slam Dunk.

Ich fürchte, ich fand die zweite Zeitung nur albern. Das erste Problem ist, dass die Beispiele für lange Namen, die sie bereitstellen, unbegründet lang sind und keine zusätzlichen Informationen enthalten. Ich denke, wir sind uns alle einig, dass es dumm ist, einen Variablennamen länger zu machen, nur um ihn länger zu machen. Ihr Beispiel für die Benennung einer Variablen distance_between_abscissae anstelle von dx ist ein Strohmann.

Noch wichtiger ist, dass ihr Experiment eher ein Test für das einfache Auswendiglernen als für das Verstehen ist. Es testet die Fähigkeit von Probanden, fehlende Teile eines Variablennamens einzufügen, wenn diese in einer Liste ohne Kontext dargestellt werden. Ja, längere Namen sind schwerer zu merken, aber wenn ich codiere, merke ich mir keine Variablennamen. Ich benutze sie, um den Kontext bereitzustellen. Ich nehme an, Sie könnten argumentieren, dass die Schwierigkeit, sich lange Variablen zu merken, das Schreiben von Code erschwert, aber Code wird weitaus häufiger gelesen als geschrieben. Welche Aktivität sollte optimiert werden?

Eine meiner wichtigsten Metriken zur Bestimmung, ob eine Codezeile lesbar ist oder nicht, ist, wie viel anderer Kontext aus anderen Zeilen gelesen werden muss, um wirklich sicherzugehen, dass Sie verstehen, was die Zeile tut.

Es ist leicht zu sagen, dass "jeder verstehen sollte, dass i, j und k Schleifenvariablen sind". Und meistens ist es wirklich offensichtlich. Trotzdem versuche ich demütig und professionell zu bleiben und gehe davon aus, dass es leicht ist, beim Programmieren Fehler zu machen. Wenn ich also ein Array von Grobbles durchlaufe, werde ich die Schleifenvariable grobbleIndex nennen. Ich könnte auch i als Abkürzung für index akzeptieren. Wenn Sie ij und k verwenden, ist es schwerer, Fehler zu erkennen, als wenn Sie den falschen Index mit dem falschen Array verwenden und so weiter. Und es wird noch schlimmer, wenn Sie eine innere Schleife haben.

PS. Zu der Zeit, als ich diese Antwort schrieb, programmierte ich Javascript auf einem 10 "Mini-Laptop mit vertikal geteiltem Bildschirm in vim und nahm mir trotzdem die Zeit, meine Schleifenvariablen rowIndex und columnIndex zu benennen.

In einigen Anwendungen kann eine kurze Variable die Daten in der Variablen einfach nicht erklären. Kurz oder lang ist irrelevant. Wenn Sie eine längere Variable verwenden, wird Ihr Code nicht langsamer. Sicherlich ist es mühsamer, einen langen Variablennamen einzugeben, aber zumindest die Person, die den Code 6 Monate später liest (was möglicherweise Sie sind), wird in der Lage sein, das Geschehen zu erkennen, ohne Spuren zu hinterlegen, sofern dies überhaupt möglich ist.

Ich denke, das Ideal ist, dass Namen beschreibend sein sollten, es sei denn ...

Die Idee, dass Namen kürzer sein können (vielleicht sollten) - und damit weniger aussagekräftig -, wenn sie einen begrenzten Geltungsbereich haben, ist nur eine Grund, vom Ideal abzuweichen.

Persönlich verwende ich häufig Kurznamen für eine kleine Anzahl von Entitäten, auf die wiederholt verwiesen wird. Zum Beispiel häufig aufgerufene app-spezifische Unterprogramme.

Ich würde niemals Bezeichnernamen mit weniger als 4-5 Zeichen verwenden, zum Beispiel könnte eine Schleifenvariable Index oder jIndex oder kIndex sein, je nachdem, wie viele innere Schleifen ich für etwas benötige, aber für andere Namen würde ich einen "Schlüssel" verwenden "String LKey" oder "int LKey", "L" für local, wenn es sich um eine Methodenvariable handelt, oder "F" für private Klassenvariablen. Alle anderen Bezeichner wie die anderen, die vor mir erwähnt wurden, sollten den Grund für das Vorhandensein im Namen erläutern "Bezeichner" Bereich ist nutzlos, nicht wahr ?!