Prefixes in Java alt und nicht mehr notwendig oder nützlich

[Ontos]

Hallo Leute

Ich verwende seit kurzem wieder Prefixes für die Bennennung von Varialben unter Java. Eigendlich ist die Verwendung ja verpöhnt nicht mehr gerne gesehen.
collections c*
Parameter bei Methoden p*
Danach folgen klingende Variablen Bezeichnungen also z.B. cLines für eine Collection die Linien darstellt.
Eingeführt habe ich es wegen der mangelhaften final Implementierung von Sun in Bezug auf Collektions und den Fehler die daraus resultieren können.
Da ich leider der einzigste Java Coder bei mir in der Firma bin, brauche ich mal einen Realitätsabgleich was andere Firmen in dieser Richtung machen.

Wie sehen eure Firmen interen Vorschriften aus?
This überall wo es möglich ist gesetzt?
Methoden Parameter alle final gesetzt?
usw..

Super Forum habt Ihr hier! Ich hoffe das Posting ist richtig einsortiert sonst bitte verschieben und sorry!

cu Jens

 

[Guest]

Nach dem ersten Einsatz von Präfixes im Code wirst du abgemahnt. Beim zweiten verprügelt.
Beim dritten fliegst du raus und wirst verprügelt.

Grund: Mann sollte sich die Definition von Klassenattributen bzw. den Code an sich vorher anschauen,
bevor man sich auf irgendwelche "Buchstaben" verlässt. Die meisten IDEs bieten auch die Funktionalität
zum ein-/ausblenden bestimmer Codeabschnitte (z.B. alle private Attribute anzeigen etc.), so dass solche
Namenskonventionen mehr die Lesbarkeit von Code erschweren als dass sie helfen.

 

[messi]

Probleme beim Erkennen der Variablentypen deuten meist auf allgemein schlechte Namensgebung oder eine fällige Refaktorisierung hin.

Aber es geht nicht generell gegen Präfixe und Suffixe, sondern gegen kryptische Ein-Zeichen-Kodierung. Wenn du statt "private LinkedList users;" z. B. "private LinkedList userList;" schreibst, dann ist dieses Suffix meines Erachtens völlig in Ordnung, auch wenn beim ersteren der Plural schon auf eine Collection oder einen Array hindeuten soll.

Letztlich solltest du aber auch eine gute IDE benutzen. Niemand schreibt Code in Emacs oder Notepad, wenn es IDEs gibt, die speziell für eine Sprache/Plattform geschaffen wurden.

 

[Ontos]

Moin Moin
Natürlich benutze ich eine IDE (Eclipse)
Wer ist den so satistisch das er Emacs für Java benutzt?

Mit dem c* für Collectionen schaffe ich einen schnelleren Zugriff auf einzelne Objecte.
Wenn ich weiß das ich in der Klasse eine Collection habe und darauf zugreifen will brauche ich nur c und automatisch vervollständigen. Schneller Zugriff auf Elemente. Das gleiche praktiziere ich bei z.B. Buttons usw. Ist das nicht Standard?
z.B. btnRunApp für einen Button der die Anwendung startet?
Das p für Methoden Paremeter habe ich eingeführt als zusätzliche Sicherheit gegen Zuweisungs Probleme (final setze ich zwar im Parameter, aber Collections können erweitert werden obwohl sie final sind! Und weil ich deswegen mal etwas länger einen Fehler gesucht habe )

Wie macht Ihr das den?

cu Jens

 

[Sky]

Arbeitest Du alleine oder in einem Team?

In einem Team sollte man sich auf eine Konvention festlegen und daran sollten sich alle halten (ob nun schön oder auch nicht)

Falls Du alleine arbeitest kann es egal sein, ob Du ein c, d, x oder q als ersten Buchstaben hast...

Ich versuche meine Variablen immer so zu bennen, dass mir sofort klar ist, worum es geht (wie auch messi schon sagte besser 'userList' als 'users'). Dazu verwende ich gelegentlich auch einen Präfix (it für Iterator)

 

[0xdeadbeef]

Beruflich programmiere ich in C und ohne IDE im Sinne des Wortes (Struktugramm-Editor).
Selbst dort ist die Typisierung innerhalb von Variablennamen verpöhnt. Und zwar hauptsächlich deshalb, weil jede Änderung des Typs eine größere Umbenennungsaktion in Source, Datenbanken und Dokumentation zur Folge hätte.
Höchstens automatische (lokale) Hilfsvariablen haben noch eine Typisierung im Namen (z.B. temp_xxx_u32).

Ich bin deshalb ehrlich gesagt auch privat komplett davon abgekommen. Letztendlich ist die Crux daran nach meinem Empfinden, daß man dann halt doch mal vergißt, den Namen an eine Typänderung anzupassen und spätestens dann ist das System völlig für die Katz: wenn man sich nicht 100% darauf verlassen kann, hat man überhaupt keinen Vorteil mehr, sondern nur noch Mehrarbeit.

 

[Bleiglanz]

Präfixe sind Zeitverschwendung, warum "btnRunApp" statt "runApplicationButton"?

das Erlernen und die Einhaltung der ganzen Regeln "btn", "lbl", "c", "p" usw. kostet doch nur Zeit und bringt praktisch keinen Produktivitätsgewinn

[...]dann halt doch mal vergißt, den Namen an eine Typänderung anzupassen und spätestens dann ist das System völlig für die Katz

und dass man das vorangestellte p bei einem Parameter irgendwann einmal vergisst ist wohl so gut wie sicher

kann sich noch jemand an VB6 erinnern? da gabs das Zuhauf, und fast immer wurde die "ungarische Notation" nur zur Hälfte durchgehalten (mache Labels hiessen lblXXX, andere eben nicht usw. usf)

 

[0xdeadbeef]

Die ganze Microsoft API ist voll damit

 

[Lim_Dul]

Meiner Ansicht nach sollten Variablen so benannt sein, dass aus ihrem Namen und dem Kontext klar hervorgeht, wofür sie gedacht ist. Das heißt der Name soll die Aufgabe der Variablen beschreiben und nicht ihren Typ. Dies hängt zwar häufig sehr eng zusammen, muss es aber nicht. Und ein Zwang auf Prefix-Regeln betont meines Erachtens den Typ der Variabeln zu sehr und legt den Fokus zuwenig auf die Aufgabe, die sie im Programm wahrnimmt.

 

[Guest]

Moin Moin

Präfixe sind Zeitverschwendung, warum "btnRunApp" statt "runApplicationButton"?

das Erlernen und die Einhaltung der ganzen Regeln "btn", "lbl", "c", "p" usw. kostet doch nur Zeit und bringt praktisch keinen Produktivitätsgewinn

Keine Gewinn?
Wenn ich ohne den Blick zu verändern oder die Maus auch nur anzufassen sofort weiß von welchem Typ ein Object ist bringt mir das einen Gewinn!
Auch grade die Auto Vervollständigen Funktion in Verbindung mit den Prefix c für Collection bringt viel.
Ich plädiere hier nicht für Prefixe für alles und jeden Typ oder die ungarische Notation sondern für einen angemessenen Umgang damit. Soviel das es Gewinn bringt, sowenig das es keine Zeit kostet.
Frage von mri nur weil ich zwar der einzigste Java Coder bei uns in der Firma bin, aber demnächst wieder Java lehren werde.

Also an alle anderen Java coder in der Industrie da draussen: Was sage eure Conventionen für bzw gegen einen verantwortungsbewusten Umgang mit Prefixes??

cu Ontos oder auch Jens

 

[Ontos]

sorry war wohl nicht eingelogt.. kann den quote Fehler also nicht korrigieren.. cu Ontos

 

[Bleiglanz]

In Java sind sie glaub ich nicht recht beliebt und die Microsoft .NET "naming conventions" verbieten explizit den Einsatz der ungarischen Notation, ich würds also nicht übertreiben

komm auf keinen Fall mit

m_iIndex

für eine Member-Variable vom Typ int daher, das widerspricht auch der relativ sinnvollen Forderung, dass man Quellcode "vorlesen" können muss

 

[bygones]

mal so ne Frage... wie schauen denn die Abkürzungen für

Integer, int, Integer[], int[], Image, Icon

aus ?

ich stell mir das auch mit den generics interessant vor

p_c_c_i_liste für Collection<Collection<Integer>> als Parameter ?!

 

[Ontos]

Moin Moin

In Java sind sie glaub ich nicht recht beliebt und die Microsoft .NET "naming conventions" verbieten explizit den Einsatz der ungarischen Notation, ich würds also nicht übertreiben

Ihh wer will den .Net auch nur anfassen?
Meine Gedanken gehen an in die Richtung gleichbleibende Lesbarkeit bei einem Zusatz an Informationen.
Also nur solche Prefixe einsetzen die Gewinn bringen und das aber konsequent!

cu Jens

 

[Bleiglanz]

Also nur solche Prefixe einsetzen die Gewinn bringen und das aber konsequent!

welche sollten das sein? Das Problem aller Code Conventions ist doch, dass sie kurz und einfach sein müssen, damit die Programmierer es überhaupt in Betracht ziehen, sie vielleicht anzuwenden...

 

[Ontos]

p_c_c_i_liste für Collection<Collection<Integer>> als Parameter ?!

Ach nöö das ist ja absolut unlesbar und wird hoffentlich nie umgesetzt werden

ich dachte eher an sowas

Vector<DonkUser>cUsers;

Vector<Integer>cNumbers;

Das die Benennenung der Values sprechend bleibt nur ein Zusatz gewählt wird um die Plural Form zu bestimmen.
Mein Problem ist das ich ein Object user habe und einen Vector users

for (Iterator<DonkUser> iter; users.iterartor();iter.Next()){
      DonkUser user= iter.next();
}

das würde mit dem c* imho lesbarer sein

for (Iterator<DonkUser> iter; cUsers.iterartor();iter.Next()){
DonkUser user= iter.next();
}
[/code]

Und nicht so fehleranfällig bzw. cu + autovervollständigen => fertig => schneller

cu Jens

 

[AlArenal]

Abgesehen davon, dass obiger Code Grütze ist:

Ich programmiere gegen Interfaces und benutze dann bestenfalls mal Suffixe, also userList und user, bzw. in Schleifen anstatt user curUser, o.ä.

Stichwort: "sprechende" Variablen-Namen

Ansonsten halte ich meinen Code so übersichtlich, dass ich stets eine möglichst geringe Anzahl von Variablen in einem Scope nutze. Dadurch und natürlich durch saubere Doku tue ich mir und anderen Entwicklern einen größeren Gefallen, als wenn ich irgendwelche Prefixe benutze, beim Rafactoring dann alles umwerfen muss und auch noch von Fall zu Fall unterschiedliche Regeln anwende - ob Präfix oder nicht ist ja reine Geschmackssache, der eine würde es an Stelle x gut finden, der andere blickts auch so und würde lieber an y.

Ganz oder gar nicht und dann doch besser gar nicht

 

[bygones]

du beharrst ziemlich auf die Autovervollständigung, dass gehe dann schneller und weniger fehleranfällig.

Das ist doch unsinn. ob ich nun meine Liste cUser oder userList nenne - ob ich nun c+Autovervoll oder u+Autovervoll eingebe ist gleich. Fehleranfälliger ist userList auch nicht. Die IDE bietet mir ja danach nur Methoden an, die für diesen Typ zur Verfügung stehen, ebenso wird angezeigt, um was für einen Typ es sich handelt. Geschweige denn, dass er nicht kompliert, wenn ein Fehler im Code ist...

wieso ist es dann weniger fehleranfällig ??

wie schon gesagt: ich empfinde es lesbarer userList statt cUser zu nehmen..... selbst users find ich logischer.

 

[Guest]

Moin moin

Danke! Ihr habt mich überzeugt!

Wollte nur mal wieder einen Realitätsabgleich haben!

cu Jens