Programierstiel

Beim Codieren von Quellcode sollte man ein paar internationale Regeln beachten. Dies fördert die Lesbarkeit und Übersichtlichkeit des Quellcodes und erleichtert das Testen der einzelnen Programmteilen.

Folgende Regeln sollten beachtet werden:

• Vor dem Codieren, sollte eine gute Planungsphase stehen
• Schreibe den Quellcode immer so, dass er auch von anderer verstanden werden kann
• Baue Deinen Code objektorientiert, modular und prozedural auf
• Verwende Kommentare um den Codepassagen zu erläutern,
  Kommentare innerhalb einer Codezeile sollte vermieden werden
• Leerstellen um den Text lesbarer zu gestalten und rücke den Zeilen ein um die Übersichtlichkeit zu erhöhen
• Verwende innerhalb eines Projektes möglichst nur einen Progammierstil
• Begrenzen Sie die Zeilenbreite auf die Bildschirmbreite, dadurch bleibt der Code übersichtlicher

Erläuterungen:

• Objektorientierte Programmierung (OOP): Darunter versteht man abgeschlossene Funktionen in Objekte zusammen zu fassen.
  

  Siehe auch Wikipedia

• Modulare Programmierung: Darunter versteht man komplext Aufgaben in kleine Schritte zu zerlegen und diese in Module zu lösen.
  

  Siehe auch Wikipedia

• Prozedural Programmierung: Darunter versteht man die herausgearbeiteten Module weiter Aufgaben zu zerlegen und diese in Prozeduren (Subs oder Funktionen) zu lösen.
  

  Siehe auch Wikipedia

Variablen

Variablennamen sollten klein geschrieben werden und nur Buchstaben aber keine Umlaute (äöü) oder Zahlen enthalten. Trennzeichen wie '_' sollten nicht verwendet werden. Weiterhin Variablennamen dürfen sich natürlich aus verschiedenen Wörtern zusammensetzen. Um die Wörter auseinander zu halten schreibt man den ersten Buchstaben groß.

VerkaeuferVorname  => möglich
VerkäuferVorname   => sollte nicht verwendet werden
Verkaeufer_Vorname => sollte nicht verwendet werden
datensatzID        => Sonderfall ID kann groß geschrieben werden

Optimiert sieht das dann so aus. Dabei wird eine Kennung vorangestellt.

vVerkaeuferVorname => Variable innerhalb einer Prozedure gültig
mVerkaeuferVorname => Variable innerhalb eines Modules gültig
gVerkaeuferVorname => Variable global gültig

Oder mit Typkennung sieht das dann so aus.

strVerkaeuferVorname   => Variable vom Typ String
lngVerkaeuferPlz       => Variable vom Typ Long Integer
dblVerkaeuferEinkommen => Variable vpm Typ Double

Oder mit kurzer Typkennung sieht das dann so aus.

sVerkaeuferVorname   => Variable vom Typ String
lVerkaeuferPlz       => Variable vom Typ Long Integer
nVerkaeuferEinkommen => Variable vpm Typ Double

Ich selber verwende die mittlere Variante.

Variablenkennung, Namenskonvention

Manchmal macht es Sinn den Variablentyp in den Namen zu integrieren. Vor allem in der Web-Programmierung finde ich diese Variante hilfreich um schnell zu erkennen welcher Typ zu erwarten ist.

Ob man nun die 3 Zeichen Langversion verwendet oder die 1-2 Zeichen Kurzversion bleibt jedem überlassen.

Datentyp Suffix  Langversion + Bsp.  Kurzversion (Präfix) + Bsp. 




Boolean    %     bln  blnSchalter    b   bSchalter
Byte             byt  bytZaehler     by  byZaehler
Integer    %     int  intZaehler     i   iZaehler
Long       &     lng  lngParam       l   lParam
Single     !     sng  sngZahl        sn  snZahl
Double     #     dbl  dblZahl        d   dZahl
Currency   @     cur  curEuro        c   cEuro
Date             dat  datDatumZeit   dt  dtDatumZeit (DateTime)
Object           obj  objBild        o   oBild
String     $     str  strText        s   sText
Variant          var  varEingabe     v   vEingabe
Type             typ  typDaten       t   tDaten      (benutzerdefiniert)

Sonderformen

Datentyp Suffix  Langversion + Bsp.  Kurzversion (Präfix) + Bsp.




Handle           hdl  hdlInteger     h   hInteger    (Handle-ID)
Error            err  errNummer      e   eNummer     (Error-ID)
Recordset        rs   rsAbfrage      rs  rsAbfrage   (Objekt Recordset)
Connection       cnn  cnnDatenbank   cn  cnDatenbank (Objekt ADODB.Connection)
Catalog          cat  catKatalog     ca  caKatalog   (Objekt ADOX.Catalog)
Table            tbl  tblAdressen    tb  tbAdressen  (Objekt ADOX.Table)
Index            idx  idxName        id  idName      (Objekt ADOX.Index)
Field            fld  fldStrasse     fl  flStrasse   (Objekt ADOX.Column)

Sinnig ist auch die Gültigkeit mit hinein zu definieren.

Gültigkeit       Kürzel   Beispiel




Prozedurebene             sstrText  oder  sText    (kein Präfix)
Modulebene          m     msstrText  oder  msText
Global              g     gstrText  oder  gsText
Statische Variable  st    ststrText oder  stsText
Wert übergeben      v     vstrText  oder  vsText   (ByVal)
Verweis übergeben   r     rstrText  oder  rsText   (ByRef, Achtung wie Recordset)




Contante            c     cstrText  oder  csText   (Konstante innerhalb einer Prozedure)
Contante            c     cmstrText oder  cmsText  (Konstante innerhalb eines Moduls)