Siehe auch
Programmierkonventionen
Konventionen haben für mich den Vorteil, dass ich mir möglichst wenig merken muss. So kann ich weniger vergessen und weniger falsch machen.
Beispiele
- Ich definiere, was prinzipiell in den Aufgabenbereich einer Funktion fällt und um was sich das aufrufende Programm kümmern muss. Die Regeln halte ich dann streng ein.
- Auch Sonderfälle, die ich derzeit nicht brauche, implementiere ich in der Funktion, oder ich lasse die Funktion in den unerwarteten Situationen mit einer Fehlermeldung abbrechen. So vermeide ich die heimtückischen "stillen" Fehler.
Bezeichnungen
- Eine treffende Bezeichnung von Variablen, Funktionen usw. nach einem durchgängigen Schema halte ich für sehr hilfreich, um Fehler zu vermeiden. Daher denke ich durchaus auch mal länger nach, wenn mir nicht gleich ein guter Name einfällt.
- Abkürzungen vermeide ich eher. Ich bin ich der Meinung, dass es i. A. weniger lang dauert, Wörter auszuschreiben als ggf. herauszufinden, was eine Abkürzung bedeutet. Ich verwende Abkürzungen nur für eine ganz kleine Menge, die ich sicher überschauen kann und aufgrund der häufigen Verwendung nicht vergesse.
- Bezeichnungen in Blockbuchstaben sind langsamer einzugeben. Daher verwende ich sie nur in Sprachen, wo sie für Konstanten üblich sind. Für SQL- oder HTML-
Befehle verwende ich Kleinbuchstaben. - Da ich Mathematiker bin, dürfen Variablennamen für offensichtliche Verwendungszwecke in Schleifen etc. auch einbuchstabig sein.
- Den Typ von Variablen gebe ich nicht durchgängig im Variablennamen an. Hilfreich ist z. B. die Unterscheidung von Textvariablen und codiertem HTML, das bereit für die Ausgabe ist.
Natürlich sind die Konventionen nicht in Stein gemeißelt: Wenn man merkt, dass sie in einem Fall kontraproduktiv sind, soll man sie in Frage stellen und ggf. abändern dürfen.
Weiter
Weblinks
Beispiele aus der Praxis:
- Microsoft: Visual Basic Coding Conventions (englisch)
- Oracle: Code Conventions for the Java Programming Language (englisch)
- MATLAB Programming Style Guidelines (englisch, PDF)