Naming Conventions (Collections)

[-frank]

hallo,

ich wollte euch fragen wie ihr eure Vectoren, Listen, Arrays, etc. benennt bzw. generell wie ihr mit längeren, zusammengesetzten variablennamen umgeht.
Ich habe vor kurzem mal gelesen, dass der plural wie bei "infos" okay ist, aber man solle keine ähnlich lautenden variablen haben. also

List<Info> infos = ..;
for(Info info:infos) {...}

soll nicht gut sein, weil info und infos schwer zu unterscheiden sind (in dem fall vielleicht nicht, weil sie so kurz sind, aber naja...)
eine andere variante ist die prefix-methode, also zb cInfo für ne Collection von Info Objekten. aber da gibts ja auch wieder viele leute, die ganz stark dagegen sind, prefixes zu verwenden.
Ich persönlich schreibe gerade an einem Program und habe dabei namen wie infoList gewählt.
aber irgendwie gefällt es mir auch nicht wirklich:
angenommen ich habe eine Klasse Student. studentList liest sich ja noch gut. woanders im programm habe ich aber eine klasse, die nicht das Student-objekt selbst, sondern nur Informationen über den Studenten benötigt. die entsprechende klasse nenne ich zB StudentInfo. weiters hat ein Student aber auch Partner-Studenten (mit denen er gemeinsam Kurse macht) --> partnerStudentList.
ein Objekt hat nun Informationen über einen Studenten (StudentInfo) und benötigt ebenso Informationen über die Partner dieses Studenten. diese Liste würde ich nach meiner regel dann partnerStudentInfoList nennen. aber ideal klingt das für mich nicht.

mögliche andere varianten wären aus meiner sicht zb, dass ich in der anderen klasse, die niemals Student-objekte hat, sondern immer nur StudentInfo, diese objekte trotzdem nur student nenne. so wird es kürzer und leserlicher, aber ich verliere natürlich die informationen, dass es sich hier nur um studentinfo-objekte handelte. IMO wäre das aber vertretbar in diesem fall.

oder ich mache die namen noch länger, dafür aber leserlicher (aus meiner sicht):
studentInfoListOfPartnerStudents
schrecklich lang, aber imo wäre es so etwas verständlicher.

das problem habe ich prinzipiell bei längeren variablen-namen, zb auch bei GUI-klassen:
angenommen ich habe ein JLabel-Objekt, dann nenne ich es einfach label. ist die klasse abgeleitet, zb PrettyLabel würde ich als variablen name wohl immer noch prettyLabel oder prettyLbl wählen. Dient ein normales Label dem Anzeigen eines Namens, heißt es bei mir wohl nameLabel (und andere dann addressLabel, etc.). ist es der Name eines Studenten, wäre ich wieder versucht es studentNameLabel zu nennen.
kombiniert wäre ich dann bei studentNamePrettyLabel. und wenn ich da noch ne Collection habe...

---

generell ist mein Problem halt, dass ich gerne informationen in meine variablen namen packe ("nameLabel" statt nur "name" oder "label"), aber es bei konsequenter verfolgung dieser regel (weil ich es eben zB auch bei Collections so halte) einfach zu lange variablennamen werden. wenn ich aber dort kürze, ist es irgendwie auch verwirrend finde ich. (man hat sich ja dran gewöhnt). generell auf infos wie "label" oder "list" zu verzichten, damit ich bei langen namen dann keine probleme haben, kommt mir auch nicht ideal vor.

also naja, vielleicht habt ihr ja ein paar tipps bzw. könnt mir sagen, wie ihr es macht.

aja, eines noch: ist es nun üblich den "_" bei klassenvariablen zu verwenden oder nicht? auch da kenn ich leute, die es gerne machen nund andere, die es hassen.

 

[Leroy42]

Ich pick' mir mal was raus, damit die anderen auch noch antworten können.

List<Info> infos = ..; 
for(Info info:infos) {...}

finde ich absolut sinnvoll und auch keinesfalls zu ähnlich.

Im Zeitalter der farbunterlegenden IDEs sollte sowas auch kein
Problem mehr darstellen.

aja, eines noch: ist es nun üblich den "_" bei klassenvariablen zu verwenden oder nicht? auch da kenn ich leute, die es gerne machen nund andere, die es hassen.

Ich gehöre eindeutig zu den Hassern einer solchen Konvention und
bin mir ziemlich sicher, das ich damit nicht alleine dastehe.

 

[Beni]

Zum einen achte ich darauf, dass meine Variablen lesbar sind, ein "cPtrNameLblImpl" kommt mir z.B. nicht in den Code. Zum anderen sollten die Namen Informationen beinhalten, aber nicht übermässig viele.
Ein "JLabel name" finde ich nicht schlimm; die wichtige Information ist, dass es etwas mit einem Namen zu tun hat. Dass es ein Label ist, kann man nachschlagen, oder erschliesst sich sowieso aus dem Kontext.
Zu den ähnlichen Namen: da ich selten lange Namen habe, habe ich auch wenig Probleme damit :wink: Ich finde es aber ganz praktisch, Arrays oder Collections den Namen "xs", und den Elementen darin "x", zu geben. Man sieht dann ihre Zusammengehörigkeit.

Und am Schluss ist sowieso nur wichtig, dass man etwas verwendet, womit alle Beteiligten glücklich sind :wink: (Konventionen sind Empfehlungen, keine Gesetze...)

[Edit]

aja, eines noch: ist es nun üblich den "_" bei klassenvariablen zu verwenden oder nicht? auch da kenn ich leute, die es gerne machen nund andere, die es hassen.

Ich gehöre eindeutig zu den Hassern einer solchen Konvention und
bin mir ziemlich sicher, das ich damit nicht alleine dastehe.

Dem schliesse ich mich an. Ein "_" unterbricht den Lesefluss. Meiner Meinung nach sollte ein Klassenname eher ein Wort, und kein Satz sein.

 

[sparrow]

Dem schliesse ich mich an. Ein "_" unterbricht den Lesefluss. Meiner Meinung nach sollte ein Klassenname eher ein Wort, und kein Satz sein.

Ich glaube -frank meint eher die weit verbreitete Angewohnheit Klassenvariablen mit einem _ zu beginnen.
In C ist das weit verbeitet.
Zumindest in Java halte ich nichts davon, da manchmal ein einzelner, manchmal zwei _ verwendet werden.

Da man sich in Java auch nicht um das freigeben der Variablen kümmern muss ist es meiner Meinung nach unnütz Variablen so heraus zu stellen. Bei gutem Code ist es sehr schnell ersichtlich ob es sich bei der Variable um eine Klassenvariable handelt oder nicht.

Ansonsten neige ich zu kurzen, englischen und verständlichen Variablen.
Für Collections das ganze ins Plural zu nehmen finde ich absolut ok und setze es selbst so um.

Bei sehr kurzlebigen Variablen achte ich auch darauf, dass der Name einen gewissen Sinn hat. Der typische Integer in einer hochzählenden for-Schleife heisst bei mir c für counter.

 

[Yzebär]

angenommen ich habe eine Klasse Student. studentList liest sich ja noch gut. woanders im programm habe ich aber eine klasse, die nicht das Student-objekt selbst, sondern nur Informationen über den Studenten benötigt. die entsprechende klasse nenne ich zB StudentInfo. weiters hat ein Student aber auch Partner-Studenten (mit denen er gemeinsam Kurse macht) --> partnerStudentList.

...

aja, eines noch: ist es nun üblich den "_" bei klassenvariablen zu verwenden oder nicht? auch da kenn ich leute, die es gerne machen nund andere, die es hassen.

Wie wäre es mit partnerList anstelle partnerStudentList. Daß es sich dabei um Partnerstudenten handelt sollte ja aus dem Kontext des Sourcecodes hervorgehen und wenn nicht, kann man ja auch einen eindeutigen Kommentar dazuschreiben. Wenn es sich um eine Liste, Collection oder Container handelt, schreibe ich das immer irgendwie in den Variablennamen hinein (z.B. studentenList, studentenColl, studentenContainer). Die Namen sollten natürlich eine gewisse Länge nicht überschreiten, dann sollte man besser agnze Teilworte weglassen, als diese abzukürzen.

Du meinst sicher Member-Variablen (*klugscheiß*)... Membervariablen sind durch "this" bereits eindeutig gekennzeichnet, Klassenvariablen durch den Klassennamen ebenso. Wer sowas "_" gut findet, sollte nicht in Java programmieren...

 

[Leroy42]

Membervariablen sind durch "this" bereits eindeutig gekennzeichnet

Vor member-Variablen immer ein this. zu setzen, halte ich für genauso eine Unsitte.
Ich benutze this. nur, wenn es unbedingt erforderlich ist
(Parameternamen identisch zu member-Variablen)

Wer sowas "_" gut findet, sollte nicht in Java programmieren...

*fullack*

 

[-frank]

danke mal an alle!
mir kommt das "_" bei membervariablen (mit klassenvariablen kann man stativ variablen bezeichnen, oder?) einfach oft unter. wirklich begeistert bin ich davon auch nicht.

zu this: also das verwende ich schon recht gern. es ist zwar mühsam beim eingeben, aber dann ist halt eindeutig gekennzeichnet, dass es ne membervariable ist. wobei man dann natürlich schon sagen kann, dass "_" kürzer ist und das this. genauso beim lesen stören kann. andererseits lass ich mir dann ganz gern von der IDE anzeigen, wenn ich ohne this zugreife. das hat mir schon einige fehler erspart.

 

[Guest]

...zu this: also das verwende ich schon recht gern. es ist zwar mühsam beim eingeben, aber dann ist halt eindeutig gekennzeichnet, dass es ne membervariable ist. wobei man dann natürlich schon sagen kann, dass "_" kürzer ist und das this. genauso beim lesen stören kann. andererseits lass ich mir dann ganz gern von der IDE anzeigen, wenn ich ohne this zugreife. das hat mir schon einige fehler erspart.

Wenn du Eclipse verwendest, dann schau dir die Präfix/Postfix Einstellungen unter Preferences->Java->Codestyle
an. Ich habe schon mal vor einiger Zeit ein Projekt gesehen, bei dem Präfixe als verbindliches
Musskriterium vorgegeben waren. (z.B. m_ für Membervariablen, v_ für lokale und p_ für Parameter )
Man kann es lieben oder hassen... man gewöhnt sich daran, selbst wenn es sich mit dem Generator
für Getter und Setter nicht verträgt.

 

[Leroy42]

man gewöhnt sich daran, selbst wenn es sich mit dem Generator
für Getter und Setter nicht verträgt.

Nix da! :noe:
Wenn, dann hat sich gefälligst mein Chef zu gewöhnen.

@frank: Ja, static-Variablen kann man als Klassenvariablen interpretieren.