Objektorientierte Programmierung MPM M13 Programmierstil Objektorientierte Programmierung MPM M13

Grundlagen “If builders built buildings the way programmers write programs, then the first woodpecker that came along would destroy civilization. “ ~ Gerald Weinberg

Tipps für Jeden Programmierer Programmierstil Tipps für Jeden Programmierer

Übersichtlichkeit des Quelltextes reduzieren. Problem: Andere Programmierer wollen Änderungen im Quelltext so schnell und einfach wie möglich umsetzen! Übersichtlichkeit des Quelltextes reduzieren. Funktionen mit mehreren Zwecken! So lange Codeabschnitte wie möglich!

Namenskonventionen Verwenden Sie sehr lange, zusammengesetzte Namen für Variablen. Unterschiedliche Variablen sollten sich um einzelne Zeichen unterscheiden! So viele Abkürzungen wie möglich. Jeder vernünftige Programmierer hat einen angeborenen Instinkt, was die Abkürzung CAPIAT heißt! Verwenden Sie Zahlen und Buchstaben als Variablen. In der Kürze liegt die Würze!

Programmfluss Alle Variablen und Funktionen werden öffentlich deklariert. Dies minimiert den Aufwand beim Datenaustausch. Löschen Sie nie!!! ungenutzten Code aus dem Programm. Man kann nicht wissen, wann man ihn noch mal braucht. Greifen Sie möglichst häufig auf Inhalte anderer Objekte zu. Dies verkürzt den Aufbau der Zielfunktion. Goto erleichtert den Sprung zwischen Programmteilen. Verwenden Sie Copy&Paste so viel wie möglich. Jede Funktion sollte etwas mehr oder weniger tun als ihr Name verspricht. Die Verwendung von Ausnahmebehandlungen macht Lücken im Code sichtbar. Vermeiden Sie das!

Ein Kunde, der weiß was er tut, braucht keine Dokumentation! Wenn Sie ein Feature nicht umsetzen konnten, schreiben Sie trotzdem in die Doku, dass Sie es umgesetzt haben! Verhindern Sie, dass man erkennen kann auf welchen Softwarestand Sie sich beziehen! Verwenden Sie Kommentare wie */1 zu i addieren/*, schwierigere Sachverhalte nicht kommentieren!

Sauberer Programmierstil MPM M13

Grundlagen Unter Programmierstil wird ein Satz von Regeln verstanden, denen sich ein Programmierer bei der Erstellung von Code unterwirft. Programmierstil dient der Kommunikation im Team und der schnellen Erfassbarkeit des Quelltextes. Lesbarkeit Verständlichkeit Wartbarkeit

Programmierrichtlinien Große Softwareprojekte hängen maßgeblich von der Kommunikation im Projekt ab. Im Projekt werden deswegen oft Regeln als Richtlinien vorab aufgestellt. Aus Richtlinien können Stereotypen und Entwurfsmuster abgeleitet werden. Entwurfsmuster?

Abwesenheit von Kommentaren ist schlechter Programmierstil! Kommentare erhöhen die Lesbarkeit für Andere! Kommentare verwenden: Kopf einer Datei Übergabewerte einer Funktion Beschreiben einer Funktion Beschreiben von Attributen

Verschachtelung von Codeelementen. Positionierung von Syntaxelementen. Einrückstil Verschachtelung von Codeelementen. Positionierung von Syntaxelementen. Einsatz von Leerzeichen und Leerzeilen.

Namen werden nach Notationen, z.B. der ungarischen Notation vergeben. Namenskonventionen Der Name einer Variable weist auf ihren Zweck hin oder deutet ihn zumindest an. Namen werden nach Notationen, z.B. der ungarischen Notation vergeben. Eine Variable wird für einen Zweck und nicht für mehrere verwendet. Variablenrecycling vermeiden.

Beschränkung der Zeilenlänge ist manueller Aufwand. Kurze Zeilenlänge fördert die Menschenlesbarkeit und Vergleichbarkeit durch Textprogramme. Beschränkung der Zeilenlänge ist manueller Aufwand. Generell gilt, nicht mehr als eine Anweisung pro Zeile.

Keine Sprünge zwischen Programmteilen, z.B. mit GoTo, verwenden. Programmfluß Keine Sprünge zwischen Programmteilen, z.B. mit GoTo, verwenden. Unkontrollierten Zugriff auf globale Variablen durch definierte Schnittstellen zwischen Funktionen ersetzen.

Objektorientierte Programmierung Anwendung der objektorientierten Programmierung kapselt Funktionen und somit die Fehleranfälligkeit. Bauweise im Model erhöht die Wieder-verwendbarkeit und Unabhängigkeit. Vererbung erhöht die Übersichtlichkeit im Projekt.

Fehlerbehandlung durch expliziten Aufruf aller möglichen Werte. Robustheit Fehlerbehandlung durch expliziten Aufruf aller möglichen Werte. Ausnahmebehandlung durch Meldung von Ausnahmewerten.

Verhältnismäßigkeit Sauberer Programmierstil soll ein Hilfsmittel sein, keine zusätzliche Hürde.

Ungarische Notation Programmierstil MPM M13

Grundlagen Die ungarische Notation ist eine Richtlinie zur Benennung von Codeelementen. In der Notation werden sprechende Variablennamen verwendet und um Präfixe und Modifikatoren erweitert.

short, int, long char used as an integer int nValue; s struct Präfix Präfix Bedeutung Beispiel b boolean bool bHasEffect; c (or none*) class Creature cMonster; ch char (used as a char) char chLetterGrade; d double, long double double dPi; f float float fPercent; n short, int, long char used as an integer int nValue; s struct Rectangle sRect; str C++ string std::string strName;

Modifikation nach Typ Wenn anwendbar, werden die folgenden Modifikationen vor den Präfix gesetzt. Modifikation Bedeutung Beispiel a array on stack int anValue[10]; p pointer int* pnValue; r reference int rnValue;

Präfixe der Sichtbarkeit Wenn anwendbar, werden die folgenden Präfixe vor die Modifikation gesetzt. Präfix Bedeutung Beispiel g_ global variable int g_nGlobalValue; m_ member of class int m_nMemberValue; s_ static member of class int s_nValue;

Guter Programmierstil Literatur und QUellen

http://www.cs.purdue.edu/homes/jv/510s05/unmaint.pdfI (24.06.2010) Literatur und Quellen www.learncpp.com (24.06.2010) http://www.cs.purdue.edu/homes/jv/510s05/unmaint.pdfI (24.06.2010) Helmut Balzert, Lehrbuch der Software-Technik, Software-Entwicklung, 3827400422, Spektrum Akad. Vlg Helmut Erlenkötter, C++: Objektorientiertes Programmieren von Anfang an, 3499600773 , rororo