2016-04-08 9 views
6

Ich finde, dass ich in meinen Namenskonventionen für Variablen oft ein wenig widersprüchlich bin, und ich frage mich nur, was die Leute für den besten Ansatz halten. Die spezifische Konvention, über die ich spreche, ist, wenn eine Variable durch ein Substantiv und ein Adjektiv beschrieben werden muss und ob das Adjektiv vor oder nach dem Substantiv stehen soll. Die Frage ist allgemein in allen Programmiersprachen, obwohl ich persönlich C++ und Python benutze.Sollten Variablennamen Adjektive vor oder nach dem Substantiv haben?

Betrachten Sie zum Beispiel eine GUI zu schreiben, die zwei Schaltflächen hat; eine auf der rechten und eine auf der linken Seite. Ich muss jetzt zwei Variablen erstellen, um sie zu speichern. Eine Option wäre, das Adjektiv vor dem Substantiv zu haben und sie left_button und right_button zu nennen. Die andere Option wäre, das Adjektiv nach dem Substantiv zu haben und sie button_left und button_right zu nennen. Mit dem ersten Fall macht es mehr Sinn, wenn Sie laut vorlesen, denn im Englischen würden Sie das Adjektiv immer vor das Substantiv stellen. Im zweiten Fall hilft es jedoch, die Daten semantisch zu strukturieren, da button die meisten Informationen über die Variable enthält und left oder right zusätzliche Informationen sind.

Also was denkst du? Sollte das Adjektiv vor oder nach das Substantiv kommen? Oder ist es ganz subjektiv?

+1

Ich bin interessiert zu hören, was andere zu diesem Thema zu sagen haben ... FWIW, ich denke, dass Konsistenz wichtiger ist als eine Konvention; der schlimmste Fall wäre ein 'left_button' neben einem' button_right' ... –

+1

Ich persönlich neige dazu, das Adjektiv nach dem Nomen zu verwenden, e, g. 'button_left'. Wenn ich dann ein Attribut hinzufügen möchte, würde ich dies am Ende hinzufügen, z.B. 'button_left_width'. Es hört sich komisch an, es laut auszusprechen, ist aber beim Lesen von Code verständlicher. – Karnivaurus

+1

@Karnivaurus Ich benutze auch Adjektiv nach dem Substantiv, weil es mit Inteli sen leichter ist, das richtige zu finden, besonders wenn sie viele sind. Durch Eingabe der Schaltfläche erhalten Sie eine gefilterte Variablenliste und Sie können sehen, welche Schaltflächen Sie deklariert haben. Ich benutze Qt-Creator. – Radek

Antwort

2

Ich denke, dass das Schreiben des Adjektivs vor dem Nomen die häufigere Sache ist. Aber wenn du eine Sekunde darüber nachdenkst, ist es einfacher, den Code nach dem Substantiv zu schreiben. Das Adjektiv kann leicht als Attribut des Nomens angesehen werden. In einer logischen Denkweise ist dies meines Erachtens der bessere Weg.

4

Ich versuche noun_adj zu verwenden, weil es dem entspricht, was ich für Funktionen verwende. Wenn ich Funktionen schreiben Ich neige dazu, verb_noun_adj, zum Beispiel zu verwenden:

def get_button_id(): 
    """Get id property of button object.""" 
    pass 

Dieses liest mir ein bisschen mehr deutlich, dass get_id_button, weil es nicht ganz klar ist, was Sie bekommen hier: ist es die button.id bekommen oder bekommt einen Button namens "id" oder vielleicht noch etwas anderes? Es sei denn, Sie erweitern den Namen, um ein bisschen klarer zu sein, wie get_id_of_button, die ein wenig zu viel für Sie sein kann.

Es gibt wahrscheinlich ein ebenso gültiges Argument gegen das, was ich hier mache, aber zumindest bin ich in meinem Wahnsinn konsequent?

+0

Verrücktheit? Meintest du Sanenness? Uped Sie! ;) –