![]() |
Mein Programmierstyl
Liste der Anhänge anzeigen (Anzahl: 1)
Hi; Ich hoffe mal der Thread ist am richtigen Ort....
Delphi-Quellcode:
{*******************************************************}
{ } { ANWENDUNGSNAME } { } { Copyright (c) 2006 Martin } { } {*******************************************************} unit server_mainform_unit; interface ... Wenn ihr den COde seht... fallen euch Dinge auf die unsauber programmiert wurden? Oder gar falsch sind? Wie sind die Kommentare? Halte ich mich an "Standards"... Also ich will nicht das Programm korigiert haben, sondern Verbesserungsvorschläge zu meinem "Styl" haben.. So.. jetzt dürft ihr mich in Stücke reißen :-D Aber bitte konstuktiv... wenn ich etwas grundverkehrt mache im Bezug auf der Verwendung von .net ---> Bitte sagt es mir!!! Danke für alle Vorschläge !!! Gruß Martin W. [edit=MrSpock]Code in den Anhang verschoben. Ist zu lang. Mfg, MrSpock[/edit] [edit=Admin]Beitrag auf Wunsch des Autors editiert. Mfg, Daniel[/edit] [edit=Admin] Mfg, Daniel[/edit] |
Re: Mein Programmierstyl
1, Wieso benennst Du deine Resourcenstrings so verständlich (Str0031)?
Ich würde für 'Profile wurden gespeichert' cStrProfileSaved oder cProfileWurdeGespeichert nehmen. 2, Für Funktionskommentare gibt es schon diverse "Standards" um diese auch relative einfach in Hilfedateien zu überführen. Siehe z.B. ![]() 3, Nicht alle Sprachabhängigen Texte wurden berücksichtigt. Siehe z.B. die Zeile
Delphi-Quellcode:
. Schau dir im Rahmen von Mehrsprachigkeit auch gleich mal
lOpenDialog.Title := 'Datei öffnen...';
![]() 4, Ich würde die Logiklassen in eine eigene Unit packen. Damit erkennst Du auch einfacher ob du "unschönerweise" zu viele Methoden als Private definiert hast bzw. ob du noch einige Methoden besser als Public definierst. 5, Dateinamen wie FDS_Server_TCPPreferences.xml solltest Du als Konstanten definieren damit du nicht mal das Problem eines Schreibfehlers hast. |
Re: Mein Programmierstyl
Schon mal danke für deine Antwort! Ihr könnte mir ruhig weiterschreiben, aber ich muss jetzt erst mal arbeiten gehen...
Also nicht wundern wenn ihr vor 22 Uhr keine Antwort von mir bekommt !!! Danke im Vorraus, ich werde nachher zu jedem einzelnen Posting von euch genau stellung nehmen :-) Versprochen :-) Bis heute abend; Gruß Martin W :-) |
Re: Mein Programmierstyl
Hallo
ich würde außerdem noch das AType ändern.
Delphi-Quellcode:
Namensgebung mußt du halt noch anpassen, dass läßt sich dann aber wesentlich einfacher lesen als 1,2,3 und mit case kannst du genauso arbeiten und du sparst dir Kommentare wie
type TSinnvollerNameTyp=(SNT_TCPSERVER,SNT_Profiles,SNT_Anwendungsklassen);
... procedure Free_Classes(AType:TSinnvollerNameTyp); ... Aufruf: Free_Classes(SNT_TCPSERVER); Free_Classes(SNT_Profiles); Free_Classes(SNT_Anwendungsklassen);
Delphi-Quellcode:
Mfg Frank
// AType
// 1 :: TCP SERVER // 2 :: Profiles |
Re: Mein Programmierstyl
In Delphi ist es eigentlich eher nicht üblich, in Bezeichnern Unterstriche zur Trennung von Wörtern zu benutzen. Also sollte
Delphi-Quellcode:
eher
Free_Classes
Delphi-Quellcode:
heissen oder auch statt
FreeClasses
Delphi-Quellcode:
das hier:
Ein_sehr_langer_Methodenname
Delphi-Quellcode:
EinSehrLangerMethodenname
|
Re: Mein Programmierstyl
server_mainform_unit enthaelt unnoetige Namensbestandteile. Das es eine Unit ist weiss man doch schon.
"geg1" unnoetig abgekuerzt und nicht mit Grossbuchstaben vorne. "Profile1" vs "Profile2" da stimmt doch was nicht. Nie gleiche Menuepunkte in veschiedenen Untermenues. Besser alles in englisch. Ich hasse gemischtsprachliche Programme. "Prepare_classes" besser "PrepareClasses". Man sollte sich strikt an den CamelCase halten und auch die Gross/Kleinschreibung durchziehen als ob Delphi casesensitiv waere. Es liest sich einfach leichter. Desgleichen bei den Typen, also "Boolean", "Integer", "True", "False" usw. so wie die Delphi-Tooltips es vorgeben. Nur "string" ist da eine Ausnahme. Schluesselworte sollten klein geschrieben werden. "Free_Classes" "besser "FreeClasses". "{ Private-Deklarationen }" schmeiss diesen Mist raus. Da hast du doch genau schon das gemacht zu was der Kommentar dich auffordert. "filetocheck: TFilename" besser "FileToCheck: TFileName" oder "FileToCheck: string". TFileName gibt es nur damit man in der IDE einen eigenen Property-Editor daran binden kann. "TLog = class" in der JVCL bevorzugen wir immer eine explizite Ableitungsangabe. "TLog = class(TObject)". "File_version", "server_mainform_form: Tserver_mainform_form", "Server_version" das sollte inzwischen klar sein. "//********************** Ausführende Prozeduren ******************************//" nichtssagend und falsch und daher ueberfluessig. { TLog.AddMessageToLog(Sender: TMemo; TextMessage: string); ----------------------------------------- Auszuführender Befehl: - Fügt einem Memo eine Nachricht mit Uhrzeit hinzu} Ebenso mit unnoetigen Bestandteilen versehen. Nur "Fügt einem Memo eine Nachricht mit Uhrzeit hinzu" enthaelt Information. Alles andere weglassen. "timetostr(now)" besser "TimeToStr(Now)". Der CamelCase wurde zur besseren Lesbarkeit erfunden. Sender.Lines.Add(timetostr(now) + ' : ' + TextMessage); Solche Strings sollten immer mit Format zusammengebaut werden und der Formatstring sollte die Positionsangaben %1 ... enthalten. Der Grund ist die Internationalisierung des Programms. Andere Sprachen koennen die Satzbestandteile unterschiedlich zusammenbauen. "if server_mainform_form.IdTCPServer1.Active = True then" umstaendlich. Einfacher ist "if server_mainform_form.IdTCPServer1.Active then". Prepare_classes ist gefaehrlich. Besser den Konstruktor der Form ueberschreiben und dort die Klassen anlegen. Entsprechend gehoert Free_Classes in den Destruktor. "function Tserver_mainform_form.Import(AType: integer; AFilename: string): boolean;" ist falsch segmentiert. Das sind zwei unterschiedliche Aufgaben die in separate Methoden gehoeren. "if FileExists(AFilename) = False then" besser "if not FileExists(AFileName) then". "if RightStr(AFilename, 4) <> '.xml' then" besser "if ExtractFileExt(AFileName) <> '.xml' then", das zeigt besser an das es hier um Filenamen geht. Ich hasse diese Vortests mit Exit. "Free_Classes(1);" wenn man es nicht sowieso anders segmentieren muesste, dann muesste hier eine Enumeration fuer den Parameter verwendet werden. Der Name ist dann viel aussagekraeftiger und sicher gegen Fehleingaben. Eine 4 wuerde naemlich durch den Compiler gehen, aber nicht funktionieren. "procedure Tserver_mainform_form.ExecuteDialog(AOnCanClose: TCloseQueryEvent; AType: TDialogType);" ueblicherweise will man doch Open- und Save-Dialoge als Komponenten auf der Form, damit sie sich merken koennen wo man schon mal war. Wieder falsch segmentiert. Entweder zwei einzelne Methoden oder ausnutzen das TSaveDialog und TOpenDialog von TCommonDialog abstammen und alles nur einmal machen. Das hier ist klassisches Copy & Paste-Programmieren. "FormCloseQuery" ist falsch. Das sollte alles nach "FormClose". "'\FDS_Server_profiles.xml'" nie Stringliterale wiederholen sondern Konstanten benutzen. In diesem Fall "cServerProfile = 'FDS_Server_profiles.xml';". Entsprechend nie den Pfad explizit zusammenbauen, sondern in eine Methode konzentrieren. Das erlaubt es dann den Speicherort zentral zu aendern. "FormShow" ist ein Versager. Die Methode wird oefters aufgerufen, aber "Prepare_Classes" ist nicht auf Mehrfachaufruf vorbereitet. Besser keine unnoetigen begin end Bloecke benutzen. Zeilen die nicht da sind stoeren beim Lesen nicht. "end; // case" Ich hasse diese Kommentare. Die Einrueckung sollte doch ausreichend sein. |
Re: Mein Programmierstyl
Eine Source hat nur zwei Zwecke: gelesen und veraendert zu werden.
Man sollte daher peinlichst darauf achten das man das immer im Auge behaelt. Strikter CamelCase und strikter Namensaufbau unterstuetzen die Lesbarkeit. Sorgfaeltige Segmentierung der Aufgaben in Methoden statt Copy & Paste erleichtert die Veraenderung. |
Re: Mein Programmierstyl
Hallo!
Was mir aufgefallen ist:
Delphi-Quellcode:
Du hältst deine begins und ends nicht konstant am selben Platz. ;)
function Tserver_mainform_form.CheckFileExtension(filetocheck: TFilename; FileExtension: string): string;
begin // Dateinamen überprüfen oder korrigieren if RightStr(filetocheck, 4) <> FileExtension then begin Result := filetocheck + FileExtension; end else begin Result := filetocheck; end; end; Die sind direkt unter function, jedoch nicht direkt unter if bzw else. Wieso rückst du da ein? Grüße Faux |
Re: Mein Programmierstyl
@ Robert Marquardt ::
Zitat:
Zitat:
Zitat:
Zitat:
Zitat:
Zitat:
Gruß Martin W. |
Re: Mein Programmierstyl
Delphi-Quellcode:
Das obige funktioniert mit beiden Formatstrings ohne das man sonst etwas an der Source aendern muss.
RsEDateOutOfRange = '%0:s - Enter a date between "%1:s" and "%2:s"';
RsEDateOutOfRange = 'Das Datum sollte zwischen "%1:s" und "%2:s liegen, aber enthält den Fehler %0:s"'; Format(RsEDateOutOfRange, ['Bla0', 'Bla1', 'Bla2']); Prepare_classes ist gefaehrlich, denn es kann mehrfach aufgerufen werden. Dabei werden aber die Objekte jeweils neu angelegt, ohne das die bisherigen geloescht werden. Ein neues Delphi-Projekt ist einfach eine Beispielableitung einer Komponente (TForm). In Prepare_classes werden Hilfsobjekte erstellt, die eigentlich doch ueber die gesamte Lebensdauer der Form vorhanden sein sollten. Deshalb sollte man den Konstruktor und Destruktor der Komponente/Form ueberschreiben und dort die Objekte erstellen bzw. loeschen. Import hat zwei unterschiedliche Aufgaben. Einmal die Profiles und einmal die Preferences. Diese Aufgaben sollten von einander unabhaengig sein und deshalb auch in separaten Methoden implementiert sein.
Delphi-Quellcode:
---> Wie soll man es sonst machen??? Also ohne Exit?? mit Endlos verschachtelten If Schleifen?
procedure Tserver_mainform_form.ExecuteDialog(AOnCanClose: TCloseQueryEvent; AType: TDialogType);
var Dialog: TCommonDialog; Title: string; begin case AType of dtOpen: begin Dialog := TOpenDialog.Create(server_mainform_form); Title := 'Datei öffnen...'; end; dtSave: begin Dialog := TSaveDialog.Create(server_mainform_form); Title := 'Speichern unter...'; end; end; try Dialog.DefaultExt := 'xml'; Dialog.Filter := 'XML File / xml|*.xml'; Dialog.Title := Title; Dialog.OnCanClose := AOnCanClose; Dialog.Options := [ofHideReadOnly,ofFileMustExist,ofEnableSizing]; Dialog.Execute; finally Dialog.Free; end; end; Weniger Exit und mehr positive IFs ("if then DoSomething"). Man kann die Tests auch in eine lokale Funktion zusammenfassen. Nach dem dritten "if not then Exit" beginnt es unlesbar zu werden. Autor: Martin W #9|BeitragVerfasst am: 19.04.2006, 01:40 Titel: Re: Mein Programmierstyl Antworten mit Zitat @ Robert Marquardt :: Zitat: Delphi-Quellcode: markieren Sender.Lines.Add(timetostr(now) + ' : ' + TextMessage); Solche Strings sollten immer mit Format zusammengebaut werden und der Formatstring sollte die Positionsangaben %1 ... enthalten. Der Grund ist die Internationalisierung des Programms. Andere Sprachen koennen die Satzbestandteile unterschiedlich zusammenbauen. Zitat: Prepare_classes ist gefaehrlich. Besser den Konstruktor der Form ueberschreiben und dort die Klassen anlegen. Entsprechend gehoert Free_Classes in den Destruktor. Zitat: "function Tserver_mainform_form.Import(AType: integer; AFilename: string): boolean;" ist falsch segmentiert. Das sind zwei unterschiedliche Aufgaben die in separate Methoden gehoeren. Zitat: ...oder ausnutzen das TSaveDialog und TOpenDialog von TCommonDialog abstammen und alles nur einmal machen. Das hier ist klassisches Copy & Paste-Programmieren. ---> Was meinst du damit genau? Zitat: "if FileExists(AFilename) = False then" besser "if not FileExists(AFileName) then". "if RightStr(AFilename, 4) <> '.xml' then" besser "if ExtractFileExt(AFileName) <> '.xml' then", das zeigt besser an das es hier um Filenamen geht. Ich hasse diese Vortests mit Exit. ---> Wie soll man es sonst machen??? Also ohne Exit?? mit Endlos verschachtelten If Schleifen? ---> Sondern? Das was ich empfohlen habe. Stell doch mal eine ueberarbeitete Version bereit. |
Re: Mein Programmierstyl
Die Pascal-Fehler sind wohl langsam abgegrast, jetzt kommt .Net an die Reihe :twisted: :mrgreen: .
Delphi-Quellcode:
Puh... Solange du nicht gerade eine große bestehende Anwendung auf .Net übertragen willst (was ich nicht glaube), solltest du die Finger von diesem VCL.Net-Zeugs nehmen. Die Dateigröße wirds dir danken, Mono ebenfalls, ich will gar nicht wissen, wie viele versteckte P/Invokes und andere Artefakte darin lauern und verspreche dir, dass du für jede einzelne Klasse der RTL/VCL ein Äquivalent in der FCL finden wirst, das zudem meistens auch noch objektorientierter ist.
uses
Windows, Messages, SysUtils, Variants, Classes, Graphics, Controls, Forms, Dialogs, Borland.Vcl.Menus, System.ComponentModel, Borland.Vcl.XPMan, Borland.Vcl.ComCtrls, Borland.Vcl.StdCtrls, System.Xml.Serialization, System.IO, Borland.Vcl.ExtCtrls, Borland.Vcl.StrUtils, IdBaseComponent, IdComponent, IdTCPServer;
Delphi-Quellcode:
Den T-Präfix darfst du ab nun reinen Gewissens wegsperren. Ein Enum-Präfix ist ungewöhnlich und in anderen .Net-Dialekten überflüssig, aber da diese mit Delphi.Net wohl weiterhin mit
type
TDialogType = (dtOpen, dtSave);
Delphi-Quellcode:
statt mit
dtOpen
Delphi-Quellcode:
angesprochen werden können, kann man das wohl gelten lassen.
DialogType.Open
Delphi-Quellcode:
Erstmal durch ein Winform ersetzen, dann die entsprechenden Framework-Komponenten benutzen.
Tserver_mainform_form = class(TForm)
MainMenu1: TMainMenu; geg1: TMenuItem; Beenden1: TMenuItem; Einstellungen1: TMenuItem; [...]
Delphi-Quellcode:
Ein öffentliches Feld? Das ist sowhl in unmanaged als auch managed Code pöse ;) .
TProfilDetails = class
public Name: String; end;
Delphi-Quellcode:
Dito. entweder in die Mainform oder eine statische Klasse.
var
server_mainform_form: Tserver_mainform_form; Profil: TProfil; TcpServerPreferences: TTcpServerPreferences; Log: TLog; ServerBefehle: TServerBefehle;
Delphi-Quellcode:
Ich weiß nicht, was der Compiler damit macht, aber es ist auf jeden Fall veraltet. Dafür gibt es Resourcendateien und die ResourceManager-Klasse.
resourcestring
Delphi-Quellcode:
Wie Robert schon sagte: Format. Ohne VCL.Net ist es dann
Sender.Lines.Add(timetostr(now) + ' : ' + TextMessage);
![]()
Delphi-Quellcode:
Da die Klassen keine Felder besitzen, nimm Klassenmethoden. Allerdings würde ich eher die Log-Klasse den Log verwalten lassen, z.B. in einer StringCollection. Dazu noch eine Methode zum Ausgeben in eine TextBox.
TLog = class
private procedure ClearLog(Sender: TMemo); procedure AddMessageToLog(Sender: TMemo; TextMessage: string); end; TServerBefehle = class private procedure StopServer; end;
Delphi-Quellcode:
Verabschiede dich von diesen hässlichen for-Schleifen, es gibt nun for-in-Schleifen :D .
for i := 0 to length(TcpServerPreferences.Bindings) - 1 do
Delphi-Quellcode:
Du willst massenweise Objekte freigeben, die überhaupt nicht IDisposable einbinden, was soll da passieren?
.Free;
![]()
Delphi-Quellcode:
if FileExists(AFilename) = False then
Delphi-Quellcode:
if not File.Exists(aFileName) then
Delphi-Quellcode:
String.SubString bzw. Path.GetExtension
RightStr(AFilename, 4)
Delphi-Quellcode:
File.Copy
function Tserver_mainform_form.CopyFile(AFileFrom: string; AFileTo: string): boolean;
Die restlichen Ersetzungen von VCL-Klassen/Prozeduren liste ich nicht auf, die kannst du mithilfe des SDKs selbst ziemlich schnell korrigieren. |
Re: Mein Programmierstyl
Hab noch einen:
Delphi-Quellcode:
besser:
if fileExists(ExtractFilePath(ParamStr(0)) + '\FDS_Server_profiles.xml') = True then
Delphi-Quellcode:
Ist a) Plattformunabhängig und b) falls irgendwann doch die Methode 'ExtractFilePath' den '\' dranhängen lässt (spätere Delphi Version) hast Du sonst zwei '\' unddannhängterisichauf :angel: .
if FileExists(IncludeTrailingPathDelimiter(ExtractFilePath(ParamStr(0)))+'FDS_Server_profiles.xml') Then
|
Re: Mein Programmierstyl
Noch besser diesen Zusammenbau eines programmspezifischen Pfades in eine Methode auslagern.
ProfilePathName und PreferencesPathName oder aehnliche Namen. Das sollte man selbst dann machen wenn man die Methode nur einmal benutzt. Indem man das Programm aus solchen genau spezifizierten Elementen zusammenfuegt, bleibt es naemlich les- und wartbar. In diesem Fall hat ein Copy & Paste Code einen Namen bekommen und man versteht was der Code macht, anstatt das man das jedesmal aufs neue herausbekommen muss. |
Re: Mein Programmierstyl
Zitat:
Path.Combine :zwinker: [edit]Und dazu noch Roberts Anmerkung, dann ist es perfekt :mrgreen: [/edit] |
Re: Mein Programmierstyl
@ Robert Marquardt ::
Zitat:
@ Khabarakh :: Zitat:
Zitat:
Ich bin gerade dabei alles schön von VCL auf ne WinForm.net Anwendung zu übertragen... :-| Wenn ich alles fertig hab, poste ich dann mal ne aktualisierte Version davon, inklusive des kompletten Source Codes und der Anwendung :-) Gruß Martin W :-) |
Re: Mein Programmierstyl
Zitat:
Create und Destroy der Form zu ueberschreiben ist auch moeglich. Da geht es aber nur um die Sicht der Dinge. Ich sehe es als eine neue Komponente bei der man besser Create und Destory ueberschreibt. Die normale Sicht ist aber eben OnCreate und OnDestroy zu verwenden. |
Re: Mein Programmierstyl
Zitat:
Zitat:
Delphi-Quellcode:
;)
Label.BackColor := Color.Transparent;
|
Re: Mein Programmierstyl
Hey das Forum hier ist echt genial... Danke schon mal an alle mir geholfen haben !!!
Ich überlege gerade ein Gemeinschaftsprojekt aus meinem Programm zu machen... ich lasse es euch wissen :-) Gruß Martin W. |
Re: Mein Programmierstyl
Zitat:
|
Re: Mein Programmierstyl
BackColor wird mit der Grafik des Parents geblendet. Weise also dem Label die PictureBox als Parent zu.
|
Re: Mein Programmierstyl
Ahhh... darauf hätte ich auch selber kommen können *grübel*
Danke :-) |
Alle Zeitangaben in WEZ +1. Es ist jetzt 19:35 Uhr. |
Powered by vBulletin® Copyright ©2000 - 2025, Jelsoft Enterprises Ltd.
LinkBacks Enabled by vBSEO © 2011, Crawlability, Inc.
Delphi-PRAXiS (c) 2002 - 2023 by Daniel R. Wolf, 2024-2025 by Thomas Breitkreuz