nicht angemeldet
Hi romy,
Als ich mein beinahe fertiges Projekt mir mal so im nachgang angeschaut habe ist mir häufig aufgefallen, dass ich trotz Doku mit einigen Dingen nichts mehr anfangen kann,d.h. ich weiss nicht mehr was ich meinte.
Das könnte ein Problem der Dokumentation sein, nicht unbedingt ausschließlich der Variablen-Namen.
Das finde ich ziemlich fatal und würde dies gern bei weiterführenden Projekten ändern.
Aha: "Lessens Learned". So macht man das auch. Und zwar immer wieder. Nach jedem Projekt.
- Wie würdet ihr die Variablen benennen, vorallendingen im Hinblick auf unterschiedliche Verwendungszwecke wie zB. Sprachvariablen, Systemvariablen, allgemeine Variablen usw.
Zuerst ein Allgemeinplatz: Mit einer eindeutigen Systemmatik (nicht nur für Variable, auch fur Funktionen, Objekte, Methoden, Prozeduren, Schnittstellen, Konstanten, Enums, blabla...). Google doch mal nach dem Begriff "Ungarische Notation". Das ist _eine_ Systematik von vielen. Vielleicht nicht die allerbeste, vielleicht sehr umstritten, aber ein gutes Beispiel, wie eine Systematik aussehen könnte, die man an seine eigene Bedürfnisse, eigenen Belange (und womöglich sogar an einer Produkt- / Abteilungs- / Firmen-weiten Coding Guideline / Programmierrichtlinie) anpassen kann.
- Deutsch oder Englisch oder gemischt?
Englisch. Weil englisch hipp ist ? Nein, weil die englischen Begriffe im Vergleich zu den deutschen (ohne Informationsverlust) oft kürzer sind, erfahrungsgemäß besser passen (GetUserData(), SetUserData() ...) und man nicht in die Verlegenheiten von Umlauten kommen kann.
- würdet ihr diese Variablen nochmals irgendwo auflisten um sie zu erläutern
Ja, klar. In der zugehörigen Modul- oder Interface-Beschreibung im Data Dictionary - Abhängig von Deiner Entwurfs- und Design-Methodik. Aber Variablen-Namen ist einer von vielen Punkten, die man bei so einem Projekt beachten sollte.
Ciao
Hans-Peter