ASP-Namenskonventionen
© rothen ecotronics, Schweiz
Autorin: Dr. Silvia Rothen, rothen ecotronics, Bern, Schweiz
Letzte Überarbeitung: 13.05.18
Damit der eigene Quell-Code verständlicher und lesbarer wird, ist es sinnvoll, bei der Benennung von Variablen mit einem Präfix zu arbeiten, das Auskunft über die Art der Variablen gibt.
Es gibt verschiedene Arten von Namenskonventionen. Die hier gezeigte und in den ASP-Kursen verwendete Konvention ist angelehnt an die Reddick-VBA-Namenskonvention, die z.B. im Access2000-Buch der Microsoft Press1) empfohlen. Ich habe sie allerdings für die Erfordernisse der Web-Programmierung stark ausgebaut. Und im Gegensatz zur Reddick-Konvention verwende ich nur Kleinschreibung. Damit muss ich mir nie überlegen, ob ich etwas klein oder gross geschrieben habe und ausserdem schont es meine Handgelenke.
Es macht übrigens Sinn, die Namenskonventionen nicht nur auf Variablen, sondern auch auf Datenbankelemente (sofern möglich) und auf Verzeichnisse sowie Dateinamen anzuwenden.
Die ebenfalls auf diesem Web Site vorhandenen ASP-Beispiele und -Übungen halten sich grösstenteils an die von mir vorgeschlagene Namenskonvention.
1) Albrecht R., Nicol, N: "Microsoft Access2000 - Das Handbuch", Microsoft Press, Unterschleissheim, 1999 (ISBN 3-86063-140-3)
Variablen
| Präfix | Angewendet auf |
| bln | Boolean, d.h. Wahr oder Falsch (wie VBA-Tutorial, nicht wie Access-Buch) |
| btn | Button / Schaltfläche |
| byte | Byte 0 bis 255 |
| cur | Währung -922'337'203'685'477.5808 to 922'337'203'685'477.5807 |
| date | Datum January 1, 100 to December 31, 9999, inclusive. |
| dbl | Double -1.79769313486232E308 to -4.94065645841247E-324 for negative values; 4.94065645841247E-324 to 1.79769313486232E308 for positive values. |
| fld | Namen von Formularfeldern, erhält möglichst den Namen des zugehörigen DB-Feldes angehängt, z.B. fldendkundnr |
| fldbestellmenge_1 | Bei nummerierten Feldern braucht es _ um einfacher zu parsen |
| frm | Namen des Formulars |
| int | Integer -32'768 bis 32'767 |
| intcounter | Zähler |
| intcounter2 | 2. Zähler (für verschachtelte FOR-Schleifen) |
| intmax | Maximalwert (z.B. für Feldlänge) |
| intmin | Minimalwert |
| lng | Long -2'147'483'648 bis 2'147'483'647 |
| lngmax | Maximalwert (z.B. für maximale Bestellmenge) |
| obj | Objekt |
| objconnordwind | Connection-Objekt für die Verbindung zur Datenbank Nordwind |
| objfs | Filesystem-Object |
| objrs | Recordset-Objekt |
| sng | Single -3.402823E38 to -1.401298E-45 for negative values; 1.401298E-45 to 3.402823E38 for positive values |
| str | normale Strings |
| strbeg | Begriff (für Übersetzungen) |
| strbeg...p | Begriff in Plural (für Übersetzungen) |
| strbtnlbl | Beschriftung eines Buttons in einem Formular |
| strconpeg | Connection-String für die Verbindung zur Datenbank Nordwind |
| strfldlbl | Beschriftung eines Formularfeldes, enthält hinten den Namen des Formularfeldes, z.B. strfldlblendkundnr |
| strparameter | Parameterstring |
| strrecfld.. | Feldbezeichnung in Select(z.B. für Mail) für Feld in Record |
| strsqldel | SQL-Statement DELETE |
| strsqlins | SQL-Statement INSERT |
| strsqlsel | SQL-Statement SELECT |
| strsqlupd | SQL-Statement UPDATE |
| strtxt | längerer Text (für Übersetzungen) |
| strtxt..1 | längerer Text in mehrere Stücke aufgeteilt |
| strtxt..a | Begriff abgekürzt (z.B. damit er auf Schaltfläche geht) |
| strtxt..u | längerer Text mit Umbrüchen |
| strurl | URL-String (z.B. für Redirect) |
| var | Typ Variant (ev. für Parameter in Prozeduren und Funktionen) |
Datenbankelemente
| Präfix | Angewendet auf |
| tbl | Tabelle |
| qry | Query oder View (Abfrage) |
Verzeichnisse
| Präfix | Angewendet auf |
| _include | Verzeichnisse für Include-Dateien |
| _private | Dateien, die von aussen nicht zugänglich sein sollten, z.B. Vorlagen, Dateien, in die Formulareingaben gespeichert werden und ähnliches |
| asp | ASP-Seiten, sollte man aus Sicherheitsgründen getrennt von statischen Seiten speichern und Verzeichnis mit anderen Zugriffsrechten ausstatten, nämlich Skriptzugriff ohne Lese- und Schreibrechte |
| css | Verzeichnis für die Cascading Style Sheets |
| db | Verzeichnis für Access-Datenbanken (falls es wegen fehlender Zugriffsrechte nicht möglich ist, diese ausserhalb des Webs zu speichern |
| deutsch | Beim mehrsprachigen Sites empfiehlt es sich für die statischen Seiten, direkt unter dem Root eine Unterteilung nach Sprache vorzunehmen |
| images | Bilderverzeichnis (ev. weiter unterteilt) |
Dateinamen
Bei den Dateinamen kann man entweder alle einzuschliessenden Funktionen und Prozeduren in einer einzelnen Datei speichern (für kleinere Projekte) oder jede Funktion oder Prozedur in einer eigenen Datei, damit auf jeder Seite nur jene Prozeduren oder Funktionen eingeschlossen werden, die es wirklich braucht. In diesem Falle sollte man die Prozeduren und Funktionen mit einem Präfix im Dateinamen kennzeichnen, das abgesehen von vorangestellten inc bei den Dateien mit dem Namen der jeweiligen Funktion übereinstimmt.
Eine Prozedur heisst z.B. procnachspann und sie ist in der Datei incprocnachspann.asp gespeichert. Mit Tools wie VisualInterdev ist es übrigens nicht sinnvoll, für Include-Dateien die Endung .inc zu verwenden (wie oft in der Literatur vorgeschlagen). Die Auszeichnung von ASP-Sprachelementen funktioniert nämlich nur in Dateien mit der Endung .asp.
| Präfix | Angewendet auf |
| fr | Frame-Steuerdatei |
| inccode | Direkt eingebundener ASP-Code, d.h. weder Prozeduren noch Funktionen |
| inccodeopen | Direkt eingebundener Code, der Connection objcon und Standard-Recordset objrs öffnet |
| inccodeclose | Gegenstück zu inccodeopen: Schliesst objcon und objrs wieder und setzt sie auf Nothing |
| incfun | Include-Datei mit Funktion, mit Typ des Ergebnisses ergänzt |
| incfunsng | Include-Datei mit Funktion, Ergebnis vom Typ sng |
| inchtml | Direkt eingebundene HTML-Elemente, z.B. Einbindung CSS etc. |
| inclanguage | Datei mit allen Sprachstrings, zuerst mehrfach verwendete und dann jene für einzelne Seiten (für dynamische Seiten auf mehrsprachigen Web Sites) |
| incproc | Include-Datei mit Prozedur |
| incvar | Definition von Variablen, die auf fast allen Seiten vorkommen, z.B. Connection String |
Und nun viel Spass beim Programmieren!
Diese Webseite wurde am 21.05.18 um 17:10 von rothen ecotronics erstellt oder überarbeitet.
Printed on 100% recycled electrons!