Gibt es einen kurzen Katalog von Variablennamen-Konventionen?

StackOverflow https://stackoverflow.com/questions/235650

Frage

Es gibt viele verschiedene Arten von Variablennamen, die ich über über die Jahre gekommen sind.

Der aktuelle Wikipedia-Eintrag auf Namenskonventionen ist ziemlich leicht ...

Ich würde gerne einen prägnanten Katalog von Variablennamen-Konventionen, um zu sehen, es durch einen Namen / Beschreibung zu identifizieren, und einige Beispiele.

Wenn eine Konvention vor allem durch eine bestimmte Plattform Gemeinschaft begünstigt wird, das wäre bemerkenswert, auch.

Ich bin aus diesem in ein Community Wiki, so wenden Sie sich bitte eine Antwort für jede Konvention, und bearbeiten erstellen, wie benötigt wird.

War es hilfreich?

Lösung

Die beste Namenskonvention festgelegt, dass ich gesehen habe, ist in dem Buch „ Code Complete “Steve McConnell hat einen großen Abschnitt in dort über Konventionen und viele Beispiele zu nennen. Seine Beispiele laufen durch eine Reihe von „Best Practices“ für verschiedene Sprachen, aber es letztlich in dem Entwickler, Entwickler-Manager verlassen, oder Architekten die spezifischen Maßnahmen zu entscheiden.

Andere Tipps

PEP8 ist der Style Guide für Python-Code, der Teil ist die Standard-Bibliothek, die relativ einflussreich in der Python-Community ist. Für Bonuspunkte, zusätzlich die Namenskonventionen zur Deckung von der Python-Standardbibliothek verwendet, bietet es einen Überblick über die Konventionen im Allgemeinen zu nennen.

Nach PEP8: Variablen, Instanzvariablen, Funktionen und Methoden in der Standardbibliothek sollen Kleine Worte von Unterstrichen zum besseren Lesbarkeit getrennt verwenden: 

foo
parse_foo
a_long_descriptive_name

Um einen Namen aus einem reservierten Wort zu unterscheiden, fügen Sie einen Unterstrich: 

in_
and_
or_

Namen, die schwach private (nicht importiert von ‚von M import *‘) beginnt mit einem Unterstrich sind. Namen, deren Privatsphäre mit Namen erzwungen werden mit doppelten Unterstrichen Mangeln beginnen. 

_some_what_private
__a_slightly_more_private_name

Namen, die ‚spezielle‘ Methoden Python sind beginnen und enden mit doppelten Unterstrichen: 

__hash__  # hash(o) = o.__hash__()
__str__   # str(o) = o.__str__()

So eine Liste von Variablennamen Konventionen für Java veröffentlicht hier . Die Liste enthält Konventionen für die Benennung von Paketen, Klassen, Interfaces, Methoden, Variablen und Konstanten.

Der Abschnitt über Variablen erklärt

  
    

Mit Ausnahme von Variablen, alles Instanz, Klasse und Klassenkonstanten sind in gemischtem Fall mit einem Klein ersten Buchstaben. Interne Wörter beginnen mit Großbuchstaben. Variablennamen sollten nicht mit Unterstrich _ oder Dollarzeichen $ Zeichen beginnen, obwohl beide erlaubt sind.

         

Variablennamen sollten noch sinnvoll kurz sein. Die Wahl eines Variablenname sollte mnemonic- sein, die entworfen ist, um die Absicht der Nutzung für den flüchtigen Beobachter anzuzeigen. Ein Zeichen Variablennamen sollten mit Ausnahme von temporären „Wegwerf“ Variablen vermieden werden. Gebräuchliche Namen für temporäre Variablen i, j, k, m und n für ganze Zahlen sind; c, d und e für die Zeichen.

  

Einige Beispiele hierfür sind 

int             i;
char            c;
float           myWidth;

Was auch immer Ihre Namenskonvention ist, es Ihnen in der Regel nicht erlauben, leicht zu unterscheiden:

  • Instanz (in der Regel privat) Variable
  • lokale Variablen (als Parameter oder lokal zu einer Funktion)

Ich verwende eine Namenskonvention auf der Nutzung auf Basis von unbestimmtem Artikel (a, ein einig) für lokale Variablen, und keinen Artikel zum Beispiel Variablen, wie sie in dieser Frage zu variable Präfix .

So ein Präfix (entweder meine Art und Weise, oder jeder anderer Präfix aufgelistet in dieser Frage ) kann einen Weg, die Raffinierung Variable Namenskonvention.

sein

Ich weiß, dass Ihre Frage auf Variablen nicht darauf beschränkt, ich wollte nur Konvention zu benennen, dass ein Teil zeigen.

Es ist die "Java Programmierer Sprachführer" von Einar Hoest.

analysierte er die grammatische Struktur der Methodennamen zusammen mit der Struktur der Methodenrümpfe und gesammelte Informationen wie:

  

Add- [noun] - * haben diese Methoden oft Parameter und Objekte erstellen.   Sie kehren sehr selten Feldwerte.   Der Ausdruck erscheint praktisch in allen   Anwendungen.

etcetera ... von Hunderten von Open-Source-Projekten gesammelt.

Für weitere Hintergrundinformationen finden Sie in seinem SLE08 Papier .

Lizenziert unter: CC-BY-SA mit Zuschreibung
Nicht verbunden mit StackOverflow
scroll top