Programmierstil Hinweise zum Programmierstil unter Microsoft Visual Fox

Diese Schulung dient der Darstellung von „gutem“ Programmierstil bei der Anwendungsprogrammierung unter Microsoft Visual

Themenübersicht Ø Dokumentationskonventionen Ø Namenskonventionen Ø Aufrufkonventionen Ø Aufräumkonventionen Ø Defensive Programmierung Ø Redundanzen

Dokumentationskonventionen Parameter immer beschreiben l Im Projektmanager immer Kurzbeschreibung eintragen l Bei jeder Methode

Namenskonventionen Immer LOCAL/LPARAMETERS, d. h. Scoping verwenden l Immer Scope-Prefix vor alle Variablen (l,

Funktionsnamenskonventionen Eindeutige Erkennbarkeit von Systemfunktionen (ohne Parameterprüfung wg. Tempo) l Eindeutige Erkennbarkeit in Stored

Aufrufkonventionen Immer Funktionen verwenden l Referenzübergabe mit @ l Möglichst Objektreferenzen übergeben statt viele

Aufräumkonventionen SET-Einstellungen vermerken und wieder herstellen l Dateieinstellungen vermerken und wieder herstellen l Objektreferenzen

Defensive Programmierung Objektreferenzen immer prüfen (auf Type, Isnull und ggf. Class) l Parameter prüfen

Redundanzen reduzieren Keinen Code kopieren (!) l Keine Methoden in Basis- oder anderen Klassen

Template für Prozeduren Parameterprüfung l SET-Einstellungen l Variablendeklaration l Assertions l Dateioperationen l Aufräumen

Ggf. Utility-Klassen Lokale Referenzen werden bei Ende automatisch freigegeben l Klasse: SET-Einstellungen l Klasse:

Hooks in Methoden/Events l Hooks sind Eingriffspunkte Ø Objektreferenz für Methodenaufruf Pre-Hooks in Ereignissen

Ggf. Programmierermenü l l l l On Key Label für SYS(1270) Aufruf FILER Aufruf

Zusatz: Gleiche Tools für alle Einheitliche Einstellungen unter Optionen l Installation Gen. Menu. X

Vielen Dank! Das waren die Themen: l Dokumentationskonventionen l Namenskonventionen l Aufrufkonventionen l Aufräumkonventionen

Wenn Fragen bestehen: Wizards & Builders Methodische Software. Entwicklung Gmb. H Frankfurter Str. 21

Slides: 17

Download presentation

Programmierstil Hinweise zum Programmierstil unter Microsoft Visual Fox. Pro Wizards & Builders Gmb. H

Diese Schulung dient der Darstellung von „gutem“ Programmierstil bei der Anwendungsprogrammierung unter Microsoft Visual Fox. Pro Wizards & Builders Gmb. H

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

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

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

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

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

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

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

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

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

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

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

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

Zusatz: Gleiche Tools für alle Einheitliche Einstellungen unter Optionen l Installation Gen. Menu. X l Installation Super. Cls l Installation Builder. B l Ggf. Projekt-Hook-Klasse l Ø wg. Versionierung App-Dateien Wizards & Builders Gmb. H

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

Wenn Fragen bestehen: Wizards & Builders Methodische Software. Entwicklung Gmb. H Frankfurter Str. 21 b 61476 Kronberg Tel. : 06173 -950906 Fax: 06173 -950907 CIS: 101605, 175 Wizards & Builders Gmb. H