| Autor |
Beitrag |
Popov
      
Beiträge: 1655
Erhaltene Danke: 13
WinXP Prof.
Bei Kleinigkeiten D3Pro, bei größeren Sachen D6Pro oder D7
|
Verfasst: Mo 07.07.03 15:26
Obwohl ich durch meinen Beitrag "Wie sollte ein guter Prozedurkopf aussehen" vorgewarnt sein sollte, daß in dem Forum kaum einer großartig um die Lesbarkeit seiner Codes bemüht ist, komme ich noch ein mal zu dem Thema zurück. Nur diesmal mit dem Namenspräfix. Zugegeben, auch ich programmiere überwiegend privat und somit nur für mich. Allerdings halte ich die Meinung, daß man sich alles einfach nur gut merken muß und man dann, einem Jahr später, wieder sofort den Code beherscht, als etwas übertrieben. Auch wenn ich in der Firma Kollegen habe, so habe ich da keine Probleme mit der Lesbarkeit des Codes. In der Regel programmiert jeder sein Code umd mischt sich nicht in die Programme des anderen. Zwar gab es vor einem Jahr den Versuch in der Firma ein Standard für alle zu entwickeln, aber da kammen die Kollegen mit den wildesten Ideen. So sollte ein normaler Funktionsname einen Präfix aus fünf Buchstaben haben, der so gut wie alles über die Funktion veraten sollte. Das war dann doch zuviel des Guten, fanden wir. Obwohl die Regel keine Erfindung des Kollegen war, sondern der Standard für (glaube ich) Microsoftprogrammierer sein sollte. Nein, daß war dann doch zuviel, weil keiner sich damit anfreunden konnte seine Copy Funktion in Zukunft scawsCopy (oder so in der Art) zu nennen. Also ich gebe auch zu, daß man auch übertreiben kann (zumindest in einer kleinen Firma oder Privat).
Nichtsdestotrotz benutzte ich schon immer Präfixe für Komponenten und Variablen. Natürlich keine Regel ohne Ausnahme - bei kleinen Programmen programmiere ich auch drauf los. Das sind aber kleine Programme an dessen Code, nachdem die fertig sind, nie wieder dran gehen werde. Anders sieht es mit größeren Programmen aus. Ich will nicht nachprüfen müssen ob "Start.Caption" jetzt der Button oder Menüeitrag ist. Deshalb kommt bei mir bei Komponenten ein Präfix vor, z.B. "btnStart.Caption". Nur sind das dann doch alles meine eigenen Erfindungen. Mich würde interresieren was ihr so benutzt, was der üblicher Standard ist. Ich will jetzt nicht die Regeln von Microsoft wieder auf den Tisch bekommen. Es ist was anderes, ob man einige tausend Kollegen hat und immer nur einen klizerkleinen Bruchteil des Programms schreibt, oder überwiegend selbst das Programm schreibt und nur etwas mehr übersicht haben will.
Also mich würde interresieren was ihr so macht. Jetzt nicht nur aus Neugier, sondern auch weil ich mich etwas mehr an die allgemenen Regeln annähern will. Ich hab einige (nicht alle) Kürzel von mir als Beispiel aufgeschreiben. Schreibt mal was ihr so benutzt. Eventuell auch die kürzel für Variablen, z.B. sName für eine Stringvariable.
Quelltext 1: 2: 3: 4: 5: 6: 7: 8: 9: 10: 11: 12: 13: 14: 15: 16:
| mnu - MainMenu pop - PopoMenu lbl - Label txt - Edit mem - Memo btn - Button tim - Timer pan - Panel img - Image bev - Bevel iml - ImageList rtf - RichEdit lib - ListBox cob - ComboBox dlg - OpenDialog dlg - SaveDialog |
_________________ Popov
|
|
Terra23
      
Beiträge: 872
Win 8
Delphi 7
|
Verfasst: Mo 07.07.03 15:34
Wenn ich mal den Anfang machen darf:
Also solche Abkürzungen bekommen meine Komponenten nicht. Wenn ich z.B. einen Knopf habe, der ein paar Zahlen zusammenzählt, heißt der z.B. dann "Summe" oder "Rechnung". Ich nenne meine Komponenten eigentlich meistens nach der Funktion, die sie ausführen sollen.
_________________ Hasta La Victoria Siempre
|
|
Popov 
      
Beiträge: 1655
Erhaltene Danke: 13
WinXP Prof.
Bei Kleinigkeiten D3Pro, bei größeren Sachen D6Pro oder D7
|
Verfasst: Mo 07.07.03 15:51
Ich hab auch gesagt, daß bei kleineren Programmen sowas kein Problem ist. Wenn das aber etwas größer ist und man die 200 Komponenten nicht mehr so leicht überblicken kann, dann wird es etwas schweieriger. Wie regelst du es aber dann, wenn du ein Button für Beenden hast und gleichzeitig ein Menüeintrag? Nennst du es dann "Beenden1" und "Beenden2"? Glaube ich nicht. Dabei ist es nicht unüblich, daß man auf die gleiche Prozedur von MainMenü, Taskbar und PopUpMenü zugreift. Es sind drei Komponenten die auf die gleiche Prozedur zugreifen. Da reicht es nicht einen guten Namen zu wählen.
_________________ Popov
|
|
StefanH
      
Beiträge: 1144
Win XP
D5 Standard, D7 Pers, D2005 Pers
|
Verfasst: Mo 07.07.03 16:02
Also, Ich benütz meistens den Anfang, also:
Label: 'L' + Bestimmung
Button, BitBin: 'B' + Bestimmung
Checkbox: 'CB' + Best.
ComboBox: 'CoBox' + Best.
ToolButton: 'TB' + Best.
MainMenuItem: 'MM' + Erster Buchstabe des Obermenüs + Best.
usw.
Bei Sachen, die nur einmal vorkommen (z.B. MainMenu) heisst dann auch MainMenu
Stefan
_________________ "Als es noch keine Computer gab, war das Programmieren noch relativ einfach."(Edsger W. Dijkstra)
"Ich bin nicht von Sinnen, sondern ich rede wahre und vernünftige Worte." (Paulus)
|
|
Klabautermann
      

Beiträge: 6366
Erhaltene Danke: 60
Windows 7, Ubuntu
Delphi 7 Prof.
|
Verfasst: Mo 07.07.03 16:34
Hallo Popov,
auch ich stelle meinen Komponeten Namen soche präfixe. Allerdings sind diese nicht wie bei dir alle gleich lang.
Ein Label beginnt bei mir z.B. mit lbl ein Edit Feld mit ed, ein ComboBox mit cb und ein CheckBox mit chk. Das Prinzip ist das selbe nur die Kürzel sind anders.
Eine große ausnahme gibt es dann doch, diese heißt Label. Label benenne ich prinzipiell nur, wenn sie im Quellcode verwendet werden. Das liegt dadran, das es viele diesen gibt, die nur andere Komponenten beschriften und sich nie verändern. Diese müssen meiner Meinung nach nicht sinvoll benannt sondern nur sinvoll beschriftet sein. Sobald aber ein Label verändert wird, sei es in Position, größe, Caption oder irgendetwas anderen, muss es einen Namen mit Präfix erhalten.
Gruß
Klabautermann
|
|
AndyB
      
Beiträge: 1173
Erhaltene Danke: 14
RAD Studio XE2
|
Verfasst: Mo 07.07.03 16:53
Meine Präfixe beginnen alle mit einem Großbuchstaben um nicht in den C/Java Stil zu verfallen.
_________________ Ist Zeit wirklich Geld?
|
|
Tino
      

Beiträge: 9839
Erhaltene Danke: 45
Windows 8.1
Delphi XE4
|
Verfasst: Mo 07.07.03 17:00
Meine Präfixe sind fast gleich wie deine Popov:
Quelltext 1: 2: 3: 4: 5: 6: 7: 8: 9:
| lbl: Label edt: Edit, Memo cmb: Combobox ckb: CheckBox btn: Button ltv: Listview trv: Treeview mnu: Menu, PopupMenu mni: MenuItem |
Gruß
Tino
|
|
CenBells
      
Beiträge: 1547
Win 7
Delphi XE5 Pro
|
Verfasst: Mo 07.07.03 17:08
hallo,
also meine Präfixe sind wie folgt. Bei visuellen Komponenten (Edit, Memo, etc) stell ich immer ein v (=visuell od. da es aus dem englischen kommt visual...  ) davor und dann werden die Kompos auch noch nach ihrer Klasse abgekürzt
Das sieht dann als name beispielsweise so aus
Quelltext 1: 2: 3:
| vLabName // ein Label, dass einen Namen darstellt vEditBetrag // ein Edit, in das man einen Betrag eingeben kann vSGUebersicht // ein Stringgrid, das eine Übersicht darstellt. |
In Methoden sieht das immer folgendermaßen aus:
Wenn ich eine Lokale Variable habe, beginnt die immer mit einem L ( = local) und dann bekommt die Variable einen aussagekräftigen Namen.
Quelltext 1: 2:
| LItemNr: Integer; // zum beispiel zum durchlaufen durch eine liste LErrorDlg: TCBErrorDlg; // für eine Instanz meines Errordialogs |
Gruß
Ken
|
|
TheUnknown
      
Beiträge: 334
|
Verfasst: Mo 07.07.03 17:21
Hallo Popov,
Quelltext 1: 2: 3: 4: 5: 6: 7: 8: 9: 10: 11: 12: 13: 14: 15: 16: 17: 18: 19: 20: 21: 22: 23:
| frm_ - Form mmn_ - MainMenu ppm_ - PopupMenu mi_ - MenuItem lbl_ - Label txt_ - Edit mmo_ - Memo btn_ - Button tmr_ - Timer pnl_ - Panel img_ - Image, ImageList bvl_ - Bevel red_ - RichEdit lst_ - ListBox, ListView, StringList# cmb_ - ComboBox dlg_ - OpenDialog, SaveDialog spb_ - SpeedButton
i - Integer, Byte, Word... s - String b - Boolean p - PChar c - Char |
Wobei die Unterstriche nur bei "echten" Komponenten angegeben werden. Nutze ich eine Komponente als VAR zur Laufzeit (durch .Create), heisst sie z.B. nur lbl oder txt...
Ausserdem bekommt jede Komponente einen "richtigen" Namen als Suffix. So, zum Beispiel: txt_Eingabe, frm_Einstellungen, lbl_UhrzeitErklaerung, iZaehler oder bWertGefunden...
================
Und auch, wenn's einige nicht glauben, es ist wirklich übersichtlicher, finde ich; besonders bei Projekten, die so ab ca. die 2500 Zeilen liegen... Zugegeben, manchmal artet es schon zu einer Fleissarbeit aus, aber auf Dauer lohnt es sich sehr... Ausserdem finde ich, fühlt sich der Sourcecode irgendwie "sauberer" an, wenn so damit arbeitet...
Programmiertechnische Grüße...
|
|
DataCool
      
Beiträge: 112
|
Verfasst: Di 08.07.03 14:40
@TheUnknown:
Bis auf drei Kürzel alles genauso !
Ich kann allen nur die Untersiche alles Trennung empfehlen hat sich bei mir über die Zeit als sehr übersichtlich und hilfreich erwiesen.
_________________ DataCool
|
|
worm
      
Beiträge: 135
D6 Prof
|
Verfasst: Di 08.07.03 15:07
Hier gibt's auch noch so 'ne Liste mit Kürzeln (nicht 100%ig die, die ich nutze). Ich benutze bei Komponenten auch Kürzel und ich benenne auch die Sachen, bei denen es eigentlich keinen Sinn macht (Label, Bevel). Die erhalten dann immer ihr Präfix wie lbl und übernehmen die Bedeutung von dem, was sie beschriften (z.B. lblMasks für die Beschriftung einer Listbox lbMasks).
_________________ In the beginning, the universe was created. This has made a lot of people very angry, and is generally considered to have been a bad move.
|
|
Raphael O.
      
Beiträge: 1596
VS 2013
|
Verfasst: Di 08.07.03 16:23
IMO lohnen sich die Präfixe wirklich, jedenfalls bei nicht allzu kleinen Projekten...
| Zitat: | ed_ - Edit
lb_ - Label
bt_ - Button |
bei den anderen bin ich mir nicht so sicher, was ich da nutze...
immer was mir grad sinnvoll erscheint  oder auch einfach ausgeschrieben:
memo_ - Memo
timer_ -Timer
red_ - Richedit
img_ - Image
das ganze hilft aber nicht nur sich wieder nach einiger Zeit in das Projekt einzuarbeiten, sondern auch während der progrmmierung eines größeren Projekts...
|
|
mimi
      
Beiträge: 3458
Ubuntu, Win XP
Lazarus
|
Verfasst: Mi 07.07.04 17:26
bei mir bleibt einfach der namen der komponente einfach gleich z.b. Edit1, Edit2, Memo2, Memo4 egal ob ich große projekte habe oderkleine *G* ich kann mir es so am besten merken *G*
_________________ MFG
Michael Springwald, "kann kein englisch...."
|
|
Luckie
Ehemaliges Mitglied
Erhaltene Danke: 1
|
Verfasst: Mi 07.07.04 18:11
| mimi hat folgendes geschrieben: | | bei mir bleibt einfach der namen der komponente einfach gleich z.b. Edit1, Edit2, Memo2, Memo4 egal ob ich große projekte habe oderkleine *G* ich kann mir es so am besten merken *G* |
Sicher? Dann kuck dir das große Projekt in 3 Monaten noch mal an. Weißt du da immer noch, was in Edit23 eingegeben werden soll? 
|
|
mimi
      
Beiträge: 3458
Ubuntu, Win XP
Lazarus
|
Verfasst: Sa 10.07.04 19:08
so viele edit komponenten habe ich meistens nicht *G*
ob ihr habt recht man sollten schon auf eine gerechte namnes verteilung achten beim programmieren
_________________ MFG
Michael Springwald, "kann kein englisch...."
|
|
obbschtkuche
Gast
Erhaltene Danke: 1
|
Verfasst: Sa 10.07.04 19:18
| mimi hat folgendes geschrieben: | | ob ihr habt recht man sollten schon auf eine gerechte namnes verteilung achten beim programmieren |
OffTopic: Stimmt, sonst fühlen sich die Komponenten ohne Präfix am Ende noch benachteiligt 
|
|