Autor Beitrag
Mashalla
ontopic starontopic starontopic starontopic starontopic starontopic starontopic starontopic star
Beiträge: 48

Windows 7 Professional
Delphi 7 Enterprise, Turbo Delphi Explorer 2006
BeitragVerfasst: Mo 07.07.08 20:31 
Jeder halbwegs professionelle Programmierer guckt ja danach, dass sein Programm auch in einem Jahr noch zu verstehen ist und deshalb gibts ja diverse Styleguides. Ich hab mir auch den auf Delphi-Treff kurz angeschaut, aber entweder hab ich einige Punkte übersehen oder sie fehlen einfach.

Wie benenne ich zum Beispiel Komponenten sinnvoll? Buttons, Forms, ListBoxes, Menu-Kompos, Popup-Einträge... Bei Buttons habe ich öfters das Präfix "bt" gesehen, kommt ganz gut, aber beim Rest?
Was ist zum Beispiel mit OnClick-Ereignissen von Buttons? Ich meine mich zu erinnern, dass es Delphi nicht passt, wenn man da am Namen rumbastelt, aber die generierten Bezeichnungen find ich ehrlich gesagt etwas kacke...
Ab wieviel Zeilen Quellcode lagert ihr das Zeug in eine separate Prozedur/Funktion aus, wenn ihr zB ein OnClick eines Buttons aufruft? Oder schreibt man einfach alles in das OnClick, sofern man es nur einmal braucht?
Wie ordnet ihr Prozeduren/Funktionen in eurem Quellcode an? Erst alle Funktionen, dann Prozeduren oder umgekehrt oder habt ihr ein anderes logisches System (alfabetisch, Kontext,...)?
Und zum Schluss noch die Frage, ab wieviel Zeilen Code ich Teile in eine andere Unit auslagern sollte?

Gruß und schönen Abend :)
Calculon
ontopic starontopic starontopic starontopic starontopic starontopic starofftopic starofftopic star
Beiträge: 676

Win XP Professional
Delphi 7 PE, Delphi 3 PRO
BeitragVerfasst: Mo 07.07.08 20:41 
user profile iconMashalla hat folgendes geschrieben:
Was ist zum Beispiel mit OnClick-Ereignissen von Buttons? Ich meine mich zu erinnern, dass es Delphi nicht passt, wenn man da am Namen rumbastelt, aber die generierten Bezeichnungen find ich ehrlich gesagt etwas kacke...

Also ich würde die so lassen und als "reservierte" Bezeichner betrachten - selbst wenn man die ändern kann (hab' ich noch nie gemacht). Wenn du sie lässt, können du und auch andere beim Quellcode durchkucken immer gleich das Ereignis im Hirn zuordnen. Ein OnClick ist ein OnClick und nicht ein IfMouseClicksOnThisControl.

Gruß
--
alzaimar
ontopic starontopic starontopic starontopic starontopic starontopic starontopic starofftopic star
Beiträge: 2889
Erhaltene Danke: 13

W2000, XP
D6E, BDS2006A, DevExpress
BeitragVerfasst: Mo 07.07.08 20:47 
Ich verpasse allen Komponenten einen Prefix, bestehend aus 2 Buchstaben. Andere nehmen 3, mir reichen 2. Dabei bezeichnet der Prefix nicht notwendigerweise die Komponentenklasse, sondern den Zweck der Komponente. Alle Eingabekomponenten (TEdit, Combobox, Memo etc.) heißen so z.b. edXXXX.

Die von Delphi generierten Eventnamen passe ich nicht an. Erstens weiss JEDER, was gemeint ist, zweitens sind sie nicht k****e, sondern einfach korrekt benannt und drittens erspare ich mir dadurch merkwürdige Fehler und viel Arbeit. Wenn dir die Namen nicht passen, werde Gärtner.

An der Anzahl der Zeilen messe ich keine Komplexität, sondern an der in der Unit/Klasse definierten Funktionalität.

_________________
Na denn, dann. Bis dann, denn.
hansa
ontopic starontopic starontopic starontopic starontopic starontopic starhalf ontopic starofftopic star
Beiträge: 3079
Erhaltene Danke: 9



BeitragVerfasst: Mo 07.07.08 20:51 
Das sind aber viele Fragen auf einmal.

Bezeichner :

mache Dir das Lleben einfacher und benutze CNPack oder GExperts. Da kann man den Prefix der Komponenten vorgeben. Bsp. neuer Button : ist bei mir voreingestellt als "btn" CNPack schlägt deshalb btn1 vor. Die 1 kommt weg und wird ausgeschrieben. => kein Button95 kommt von alleine zustande. Man wird quai sanft gezwungen einen sinnvollen Namen zu wählen. OnClick wird dann eben zu btnClick.

Gruppierung von Funktionen/Procedures, Units :

was zusammengehört kommt zusammen in eine Unit und fertig. Relativ unwichtige Sachen kommen meist unten hin, wegen Ausdrucken. Ich drucke manchmal die Deklaration aus und die dann am Anfang stehenden Prozeduren. Dann braucht man nicht alles einzeln blockweise auszudrucken oder auch unwichtiges.

Quelltext-Größe :

Ab ca. 1000 Zelen pro Unit wirds langsam Zeit, das aufzuteilen. Bei Prozeduren wirds manchmal eng mit 2 DIN A 4 Seiten. U.a. auch deshalb halte ich mich in einem Punkt nicht an den Styleguide :

ausblenden Delphi-Quelltext
1:
2:
if...then
begin


schreibe ich lieber so ;

ausblenden Delphi-Quelltext
1:
if...then begin					


@gelber Kasten : ed sind bei mir auch alle xyEdits.

_________________
Gruß
Hansa

Für diesen Beitrag haben gedankt: Hidden
delfiphan
ontopic starontopic starontopic starontopic starontopic starontopic starontopic starhalf ontopic star
Beiträge: 2684
Erhaltene Danke: 32



BeitragVerfasst: Mo 07.07.08 20:53 
user profile iconMashalla hat folgendes geschrieben:
Bei Buttons habe ich öfters das Präfix "bt" gesehen, kommt ganz gut, aber beim Rest?
Entspricht eigentlich nicht unbedingt den Borland Richtlinien. Die ungarische Notation wird üblicherweise nur bei Aufzählungen verwendet. Das ganze ist aber mehr oder weniger Geschmackssache.
Mashalla Threadstarter
ontopic starontopic starontopic starontopic starontopic starontopic starontopic starontopic star
Beiträge: 48

Windows 7 Professional
Delphi 7 Enterprise, Turbo Delphi Explorer 2006
BeitragVerfasst: Mo 07.07.08 21:21 
user profile iconalzaimar hat folgendes geschrieben:
Wenn dir die Namen nicht passen, werde Gärtner.


Wenn du sowas nicht lassen kannst, dann antworte bitte nicht...

Das Präfix "ed" finde ich sehr gut, werd ich evtl auch in Zukunft so machen und damit deck ich auch die meistbenutzten Komponenten ab. Aber das CNPack schau ich mir auch mal an, das hab ich bereits empfohlen bekommen ;)

@ delphifan:

Ja, ich will mich eig nicht komplett dem Styleguide von Borland unterwerfen, ich wollte nur paar Tipps haben, wie ich den Quelltext besser verständlich formatieren kann. Der Borland-Styleguide steht zum Beispiel in einigen Dingen im krassen Widerspruch zu meinem ADA-Styleguide an der Uni und die Sprachen sind sich ja extrem ähnlich. Ich wähl da wohl meinen eigenen Weg und such mir das Passende aus Allem heraus ;)
delfiphan
ontopic starontopic starontopic starontopic starontopic starontopic starontopic starhalf ontopic star
Beiträge: 2684
Erhaltene Danke: 32



BeitragVerfasst: Mo 07.07.08 21:39 
Naja, die ungarische Notation wurde meines Wissens eher für nicht streng typisierte Programmiersprachen konzipiert. Bei "höheren" Objektorientierten Sprachen (Java,C#,Delphi) ist das heute weniger gebräuchlich und wird von Microsoft für C# bespw. nicht mehr empfohlen. Ausserdem versuche ich möglichst auf Kürzel zu verzichten.

Ein Button heisst bei mir z.B. "SaveButton", der entsprechende Event "SaveButtonClick"; Viele Komponenten benenne ich auch gar nicht um. So z.B. bei Label oder OpenDialogs. Viel wichtiger als die Benennung von GUI Buttons ist für mich jedoch die Benennung von Klassen, Methoden und Properties.
Grenzgaenger
Ehemaliges Mitglied
Erhaltene Danke: 1



BeitragVerfasst: Mo 07.07.08 21:49 
user profile icondelfiphan hat folgendes geschrieben:
Naja, die ungarische Notation wurde meines Wissens eher für nicht streng typisierte Programmiersprachen konzipiert. Bei "höheren" Objektorientierten Sprachen (Java,C#,Delphi) ist das heute weniger gebräuchlich und wird von Microsoft für C# bespw. nicht mehr empfohlen.


wusste gar nicht, dass das präfix aus ungarn kommt .. hatte irgendwie im gedächdnis, dass das ganze von M$ kommt und zwar vom chefentwickler von Excel ... damit er unterscheiden konnte was 'n char und 'n int ist ... ;-)

die aufgabe nimmt einen ja heutzutage der compiler ab ... :-)

aber nix nichtsdestotrotz nehm auch ich gern 'n prefix für die komponenten, damit man gleich weis was einen erwartet .. z.b. 'ne "e" für 'n edit .. oder 'n "cb" für 'ne combobox .. wobei das präfix bei mir immer klein geschrieben wird und der erste buchstabe des komponentnenamens dann gross :-)
Jerk
ontopic starontopic starontopic starontopic starontopic starontopic starontopic starofftopic star
Beiträge: 251

Vista Ultimate, Ubuntu
Turbo Delphi 2006
BeitragVerfasst: Mo 07.07.08 21:58 
Ich erstelle für "größere" klassen immer eigene Units, bzw für Sachen die mit dem "davor" nichts am Hut haben.

Als Präfix benutze ich immer zwei Buchstaben wie schon beschrieben. Einrücken ist selbstverständlich.
Hidden
ontopic starontopic starontopic starontopic starontopic starontopic starofftopic starofftopic star
Beiträge: 2242
Erhaltene Danke: 55

Win10
VS Code, Delphi 2010 Prof.
BeitragVerfasst: Mo 07.07.08 22:32 
user profile iconhansa hat folgendes geschrieben:

ausblenden schreibe ich lieber so:
1:
if...then begin					

in dem Punkt finde ich die Richtlinien blöd :P schreibe ich auch immer so.

Ich muss aber doch mal loswerden, dass ich es toll finde, wenn sich die Leute mit Formatierung beschäftigen :) In meinem Info-Kurs muss ich als erstes immer den Quelltext formatieren, wenn ich jemandem helfen soll :cry: Das kennen wir wohl alle(auch, wenn man den Source natürlich durch formatieren kennen lernt)

mfG,

_________________
Centaur spears can block many spells, but no one tries to block if they see that the spell is a certain shade of green. For this purpose it is useful to know some green stunning hexes. (HPMoR)
Ebil
ontopic starontopic starontopic starontopic starontopic starontopic starontopic starontopic star
Beiträge: 131



BeitragVerfasst: Mo 07.07.08 22:58 
Ich hab zwar noch nie nen styleguide gelesen, aber denke ich mache alles soweit richtig.
wenns um kleine if then konstruktionen geht, schreib ich alles in eine zeile, da wär mir auch egal was irgendjemand dazu sagt ( wie meine lehrerin :D ).
Buttons bennene ich mit "bt", editfelder mit "txt" und alles andere mit 2 buchstaben, wobei ich manche sachen auch einfach lasse.
Wenn ich nur 1 memo hab, heisst es auch nur memo, oda memo1, wozu auch umbennen?
labels die nicht geändert werden behalten ihren namen, alle anderen heissen sinngemäß etwas mit "lb" als präfix.

Ebil

//Edit:
Zitat:

Ich muss aber doch mal loswerden, dass ich es toll finde, wenn sich die Leute mit Formatierung beschäftigen :) In meinem Info-Kurs muss ich als erstes immer den Quelltext formatieren, wenn ich jemandem helfen soll :cry: Das kennen wir wohl alle(auch, wenn man den Source natürlich durch formatieren kennen lernt)

Same here~
hansa
ontopic starontopic starontopic starontopic starontopic starontopic starhalf ontopic starofftopic star
Beiträge: 3079
Erhaltene Danke: 9



BeitragVerfasst: Mo 07.07.08 23:28 
user profile iconMashalla hat folgendes geschrieben:
user profile iconalzaimar hat folgendes geschrieben:
Wenn dir die Namen nicht passen, werde Gärtner.


Wenn du sowas nicht lassen kannst, dann antworte bitte nicht...


Du willst nur hören, was dir passt ? Na gut, Gärtner sage ich zwar nicht. Besser wäre schon Busfahrer/in. :mrgreen:

Zitat:
Ja, ich will mich eig nicht komplett dem Styleguide von Borland unterwerfe...


Der ist aber schon gut, wie gesagt, bis auf das :

user profile iconHidden hat folgendes geschrieben:
user profile iconhansa hat folgendes geschrieben:

ausblenden schreibe ich lieber so:
1:
if...then begin					

in dem Punkt finde ich die Richtlinien blöd :P schreibe ich auch immer so.


Meine Kritik in dem Punkt ist nicht etwa nur die verschwendete Zeile. Dass zu einem begin ein end; gehört ist ja wohl klar. Nur zu welchem jetzt ? :shock:

Eine geeignete Einrückung vorausgesetzt, Verzicht auf Tabs (siehe ADA-Styleguide) und man geht mit Cursor so lange rauf, bis man auf das zugehörige if/while etc. trifft.

Habe das hier durch Zufall gefunden :

www.epinasoft.com/de...s/dkk_compnames.html

Das deckt sich ziemlich mit meinen Prefixen. Das hier ist nämlich Sch**** :

user profile iconEbil hat folgendes geschrieben:
Ich hab zwar noch nie nen styleguide gelesen, aber denke ich mache alles soweit richtig. labels die nicht geändert werden behalten ihren namen, alle anderen heissen sinngemäß etwas mit "lb" als präfix.


lb ist schlecht wegen der Listbox und den Labels. Deshalb : Listbox = lb und Label = lbl. In dem Link ist die Combobox auch nicht so geschickt gewählt als "cb". Combobox ist bei mir cbo und Checkbox cbx. Deshalb sind eben 2 Buchstaben etwas zu spärlich.

Interessant ist vielleicht noch das :

Turbopower hat folgendes geschrieben:
FF2MKVV.*
|||
||+------ VV VCL version (30=Delphi 3, 35=C++Builder 3, 70=Delphi 7)
|+------- K Kind of package (R=runtime, D=designtime)
+-------- M Product-specific modifier, typically an underscore

For example, the FlashFiler 2 runtime package files for Delphi 7 have
the filename FF2_R70.*.


Die Dateinamen sollte man nämlich auch nicht vergessen. Die haben das mit den Bezeichnern in den einzelnen Units ähnlich gemacht. Ebenso mit der Aufteilung der diversen Komponenten in Units.

_________________
Gruß
Hansa
alzaimar
ontopic starontopic starontopic starontopic starontopic starontopic starontopic starofftopic star
Beiträge: 2889
Erhaltene Danke: 13

W2000, XP
D6E, BDS2006A, DevExpress
BeitragVerfasst: Di 08.07.08 06:06 
user profile iconMashalla hat folgendes geschrieben:
user profile iconalzaimar hat folgendes geschrieben:
Wenn dir die Namen nicht passen, werde Gärtner.
Wenn du sowas nicht lassen kannst, dann antworte bitte nicht...

Meine Herren, wie empfindlich. Ich dachte, ich könnte einmal auf ein :) oder ein ;) verzichten. Im Übrigen meine ich das wirklich so: Es ist eine Unsitte von Anfängern, an Nomenklaturen und Äußerlichkeiten rumzumosern, anstatt sich auf das Wesentliche zu konzentrieren.

Auch wenn Du es nicht hören willst:
Ich verwende zur halbautomatischen Benennung im Übrigen die GExperts. Bei dem Experten 'Rename Components' kann man noch zusätzliche Property-Namen pro Klasse angeben, die bei der Erstellung a) gleich mit Defaultwerten oder b) mit abgefragt werden. Sehr praktisch.

Ich würde mir den VCL-Code mal reinziehen, der ist ordendlich geschrieben. Auch die JCL/JVCL sieht ganz gut aus.

Besorg Dir noch einen Code-Formatter und ein Crossreferencing-Tool, dann sieht dein Code zumindest nach was aus. Wenn dann noch der Inhalt stimmt...

_________________
Na denn, dann. Bis dann, denn.
Robert.Wachtel
ontopic starontopic starontopic starontopic starontopic starhalf ontopic starofftopic starofftopic star
Beiträge: 895
Erhaltene Danke: 7

Windows 7 Ultimate x64
D5 Ent, D7 Arch, RAD Studio 2010 Pro, VS 2008
BeitragVerfasst: Di 08.07.08 09:13 
user profile iconGrenzgaenger hat folgendes geschrieben:
[...] wusste gar nicht, dass das präfix aus ungarn kommt .. hatte irgendwie im gedächdnis, dass das ganze von M$ kommt und zwar vom chefentwickler von Excel ... damit er unterscheiden konnte was 'n char und 'n int ist ... ;-) [...]

Stimmt beides: de.wikipedia.org/wiki/Ungarische_Notation
Mashalla Threadstarter
ontopic starontopic starontopic starontopic starontopic starontopic starontopic starontopic star
Beiträge: 48

Windows 7 Professional
Delphi 7 Enterprise, Turbo Delphi Explorer 2006
BeitragVerfasst: Di 08.07.08 22:47 
Zitat:
Ich muss aber doch mal loswerden, dass ich es toll finde, wenn sich die Leute mit Formatierung beschäftigen :) In meinem Info-Kurs muss ich als erstes immer den Quelltext formatieren, wenn ich jemandem helfen soll :cry: Das kennen wir wohl alle(auch, wenn man den Source natürlich durch formatieren kennen lernt)


Joa...also wenn man einmal sauber formatierten Code gesehen hat, will man eigentlich nichts anderes mehr sehen. Ich hab auch schon Anfälle bekommen, wenn mir ein Kommilitone schlecht formatierten Code gegeben hat. Und es ist ja eigentlich kein Hexenwerk, wenn man sihc mal etwas damit beschäftigt hat und die Regeln verinnerlicht hat ;)

Also GExperts...ich weiß ja nicht, wie ich jemals ohne das Teil ausgekommen bin, das find ich richtig klasse!
alzaimar
ontopic starontopic starontopic starontopic starontopic starontopic starontopic starofftopic star
Beiträge: 2889
Erhaltene Danke: 13

W2000, XP
D6E, BDS2006A, DevExpress
BeitragVerfasst: Mi 09.07.08 07:03 
[quote="user profile iconMashalla"]
Zitat:
Ich muss aber doch mal loswerden, dass ich es toll finde, wenn sich die Leute mit Formatierung beschäftigen :)

Ja ja, ich sach ja nix mehr. Hast schon Recht.
Zitat:
Also GExperts...ich weiß ja nicht, wie ich jemals ohne das Teil ausgekommen bin, das find ich richtig klasse!

:zustimm: Und dazu noch DelForExp, ein Codeformatter, der mit den Code mit Ctrl+D sauber formatiert.

_________________
Na denn, dann. Bis dann, denn.
Lossy eX
ontopic starontopic starontopic starontopic starontopic starontopic starontopic starhalf ontopic star
Beiträge: 1048
Erhaltene Danke: 4



BeitragVerfasst: Mi 09.07.08 08:08 
user profile iconMashalla hat folgendes geschrieben:
Joa...also wenn man einmal sauber formatierten Code gesehen hat, will man eigentlich nichts anderes mehr sehen. Ich hab auch schon Anfälle bekommen, wenn mir ein Kommilitone schlecht formatierten Code gegeben hat. Und es ist ja eigentlich kein Hexenwerk, wenn man sihc mal etwas damit beschäftigt hat und die Regeln verinnerlicht hat ;)

Wobei ich dazu aber nur das sagen kann was ich sonst auch immer sage. So etwas hängt auch stark von dem persönlichen Geschmack ab. Dort kann man meiner Meinung nach keine allgemeingültigen Regeln aufstellen nach dennen sich alle richten müssen/sollten. Wo ich aber vollkommen zustimme ist, dass eine sinnvolle Formatierung in jedem Falle eine MUSS ist. Alleine schon um die Struktur/Arbeitsweise und eventuelle Fehlermöglichkeiten sehen zu können. Dort spielen meiner Meinung nach auch aussagekräftige Bezeichner eine sehr große Rolle. Und nicht zu vergessen dabei der generelle Aufbaue und die Struktur des Codes. Negativbeispiel da der so häufig beschworene "Spagetticode".

Allen in allem kann man ja sagen. Es kommt auf das Gesamtkunstwerk an. ;)

_________________
Nur die Menschheit ist arrogant genug, um zu glauben sie sei die einzige intelligente Lebensform im All. Wo nicht mal das nachhaltig bewiesen wurde.