Wizards & Builders GmbH Programmierstil Hinweise zum Programmierstil unter Microsoft Visual FoxPro

Wizards & Builders GmbH Diese Schulung dient der Darstellung von gutem Programmierstil bei der Anwendungsprogrammierung unter Microsoft Visual FoxPro

Wizards & Builders GmbH Themenübersicht Dokumentationskonventionen Dokumentationskonventionen Namenskonventionen Namenskonventionen Aufrufkonventionen Aufrufkonventionen Aufräumkonventionen Aufräumkonventionen Defensive Programmierung Defensive Programmierung Redundanzen reduzieren Redundanzen reduzieren Template für Prozeduren Template für Prozeduren Utility-Klassen Utility-Klassen Hooks in Methoden und Events Hooks in Methoden und Events Tip: Programmierermenü Tip: Programmierermenü

Wizards & Builders GmbH Dokumentationskonventionen Parameter immer beschreiben Parameter immer beschreiben Im Projektmanager immer Kurzbeschreibung eintragen Im Projektmanager immer Kurzbeschreibung eintragen Bei jeder Methode / Eigenschaft einen Kurztext eintragen Bei jeder Methode / Eigenschaft einen Kurztext eintragen Jeden neuen Abschnitt mit Kommentar beginnen Jeden neuen Abschnitt mit Kommentar beginnen

Wizards & Builders GmbH Namenskonventionen Immer LOCAL/LPARAMETERS, d.h. Scoping verwenden Immer LOCAL/LPARAMETERS, d.h. Scoping verwenden Immer Scope-Prefix vor alle Variablen (l,g,p,t) Immer Scope-Prefix vor alle Variablen (l,g,p,t) Immer Typangabe zu allen Variablen/Prop. (c,n,l,d usw.) Immer Typangabe zu allen Variablen/Prop. (c,n,l,d usw.) Möglichst Properties verwenden Möglichst Properties verwenden

Wizards & Builders GmbH Funktionsnamenskonventionen Eindeutige Erkennbarkeit von Systemfunktionen (ohne Parameterprüfung wg. Tempo) Eindeutige Erkennbarkeit von Systemfunktionen (ohne Parameterprüfung wg. Tempo) Eindeutige Erkennbarkeit in Stored Procedures von DBCs. Eindeutige Erkennbarkeit in Stored Procedures von DBCs. Zweiteilige Methodennamen Zweiteilige Methodennamen Erkennbarkeit von Events Erkennbarkeit von Events

Wizards & Builders GmbH Aufrufkonventionen Immer Funktionen verwenden Immer Funktionen verwenden Referenzübergabe Referenzübergabe Möglichst Objektreferenzen übergeben statt viele Parameter Möglichst Objektreferenzen übergeben statt viele Parameter Bei mehr als einem Vorgang in einer Methode eine Steuer-methode und Untermethoden! Bei mehr als einem Vorgang in einer Methode eine Steuer-methode und Untermethoden!

Wizards & Builders GmbH Aufräumkonventionen SET-Einstellungen vermerken und wieder herstellen SET-Einstellungen vermerken und wieder herstellen Dateieinstellungen vermerken und wieder herstellen Dateieinstellungen vermerken und wieder herstellen Objektreferenzen löschen (ggf. in Gegen/Destroy-Methode) Objektreferenzen löschen (ggf. in Gegen/Destroy-Methode) OLE-Anwendungen beenden OLE-Anwendungen beenden

Wizards & Builders GmbH Defensive Programmierung Objektreferenzen immer prüfen (auf Type, Isnull und ggf. Class) Objektreferenzen immer prüfen (auf Type, Isnull und ggf. Class) Parameter prüfen für Nicht- Systemfunktionen Parameter prüfen für Nicht- Systemfunktionen Assertions für alle Parameter Assertions für alle Parameter Maximalanzahl/länge prüfen Maximalanzahl/länge prüfen

Wizards & Builders GmbH Redundanzen reduzieren Keinen Code kopieren (!) Keinen Code kopieren (!) Keine Methoden in Basis- oder anderen Klassen kopieren Keine Methoden in Basis- oder anderen Klassen kopieren Standardfunktionen bauen Standardfunktionen bauen Bedingungen möglichst weit innen plazieren Bedingungen möglichst weit innen plazieren

Wizards & Builders GmbH Template für Prozeduren Parameterprüfung Parameterprüfung SET-Einstellungen SET-Einstellungen Variablendeklaration Variablendeklaration Assertions Assertions Dateioperationen Dateioperationen Aufräumen (SET, Datei) Aufräumen (SET, Datei)

Wizards & Builders GmbH Ggf. Utility-Klassen Lokale Referenzen werden bei Ende automatisch freigegeben Lokale Referenzen werden bei Ende automatisch freigegeben Klasse: SET-Einstellungen Klasse: SET-Einstellungen Klasse: Datei-Einstellungen Klasse: Datei-Einstellungen Klasse: Eigenschaften Klasse: Eigenschaften

Wizards & Builders GmbH Hooks in Methoden/Events Hooks sind Eingriffspunkte Hooks sind Eingriffspunkte Objektreferenz für Methodenaufruf Objektreferenz für Methodenaufruf Pre-Hooks in Ereignissen (If) Pre-Hooks in Ereignissen (If) Post-Hooks in Methoden (Ret) Post-Hooks in Methoden (Ret) Ereignisse rufen Methoden Ereignisse rufen Methoden Methoden rufen ggf. Methoden Methoden rufen ggf. Methoden

Wizards & Builders GmbH Ggf. Programmierermenü On Key Label für SYS(1270) On Key Label für SYS(1270) Aufruf FILER Aufruf FILER Aufruf CD GETDIR() Aufruf CD GETDIR() Aufruf _CLIPTEXT = GETDIR() Aufruf _CLIPTEXT = GETDIR() SET SYSMENU SAVE / DO DEFA SET SYSMENU SAVE / DO DEFA Hotkeys für SUSPEND / STEP INTO Hotkeys für SUSPEND / STEP INTO Liste Projektdateien Liste Projektdateien ggf. Aufruf Calculator, Calendar ggf. Aufruf Calculator, Calendar

Wizards & Builders GmbH Zusatz: Gleiche Tools für alle Einheitliche Einstellungen unter Optionen Einheitliche Einstellungen unter Optionen Installation GenMenuX Installation GenMenuX Installation SuperCls Installation SuperCls Installation BuilderB Installation BuilderB Ggf. Projekt-Hook-Klasse Ggf. Projekt-Hook-Klasse wg. Versionierung App-Dateien wg. Versionierung App-Dateien

Wizards & Builders GmbH Vielen Dank! Das waren die Themen: Dokumentationskonventionen Dokumentationskonventionen Namenskonventionen Namenskonventionen Aufrufkonventionen Aufrufkonventionen Aufräumkonventionen Aufräumkonventionen Defensive Programmierung Defensive Programmierung Redundanzen reduzieren Redundanzen reduzieren Template für Prozeduren Template für Prozeduren Utility-Klassen Utility-Klassen Hooks in Methoden und Events Hooks in Methoden und Events Tip: Programmierermenü Tip: Programmierermenü

Wizards & Builders GmbH Wenn Fragen bestehen: Wizards & Builders Methodische Software- Entwicklung GmbH Frankfurter Str. 21b Kronberg Tel.: Fax: CIS: ,175