OBS/Adminhilfe/Syntax: Unterschied zwischen den Versionen

Aus OBS Wiki
Zur Navigation springen Zur Suche springen
Für diese Seite wurde eine Zugriffsbeschränkung eingerichtet. Falls du diese Nachricht siehst, bist du nicht berechtigt, diese Seite einzusehen.
Keine Bearbeitungszusammenfassung
Keine Bearbeitungszusammenfassung
 
(2 dazwischenliegende Versionen desselben Benutzers werden nicht angezeigt)
Zeile 1: Zeile 1:
{{ZugriffOBS}}
{{ZugriffOBS}}
=Syntax-Regeln=
=Syntax-Regeln=


==1. Programmaufbau==
==1. Programmaufbau==
Zeile 37: Zeile 39:
===2.5 Header===
===2.5 Header===


In Header werden Nutzdaten, ergänzende Zusatzinformationen, so genannte Metadaten, am Anfang eines Datenblocks gesetzt. Sie lassen sich mit GExperts definieren und per Tastenkürzel ({{Shift}}+{{Alt}}+'''T''') automatisch einfügen.
In Header werden Nutzdaten, ergänzende Zusatzinformationen, so genannte Metadaten, am Anfang eines Datenblocks gesetzt. Sie lassen sich mit GExperts definieren und per Tastenkürzel ({{Shift}}+{{Alt}}+{{T}}) automatisch einfügen.


===2.6 Unit===
===2.6 Unit===
Zeile 116: Zeile 118:


Die InitSelection ist immer Global. Ihre ID ist 10stellig.
Die InitSelection ist immer Global. Ihre ID ist 10stellig.

Aktuelle Version vom 19. Juni 2012, 14:58 Uhr

Dies ist eine zugriffsgeschützte Seite.


Admin-Hilfe

OBS-Administration / Installation
kundenspezifische Anpassungen
OBS Protokolle
Shop-Administration

Syntax-Regeln

1. Programmaufbau

SYNTAX 1.jpg

2. Standard Source Code Formatierung

2.1 Einzug

Der Einzug sind 4 Leerzeichen. Keine Tabs, da diese mit anderen Programmen, bei anderen Usern falsch dargestellt werden könnten.
Dies kann geändert werden, indem die Checkboxen bei Füllen mit Tabs“ und „Automatische Tabs“ unter "Tools -> Editor-Optionen…" deaktiviert werden.

SYNTAX 2.jpg

2.2 Zeilenlänge

Die Zeilenlänge beträgt 80 Zeichen. Sollte eine Zeile länger sein, wird diese logisch auf 2 Zeilen umgebrochen.

SYNTAX 3.jpg

2.3 Blöcke

Logisch zusammengehörige Programmabläufe werden nach Möglichkeit immer in Blöcken durch Absätze gekennzeichnet.

SYNTAX 4.jpg

2.4 Kommentare

Kommentare werden innerhalb von “{ …}“ oder “(* … *)“ geschrieben.
Soll nur eine Zeile auskommentiert werden, setzt man am Zeilenanfang  “//“.

Wir schreiben Kommentare grundsätzlich mit //.

Ein Kommentar, das am Zeilenanfang steht, ist unwichtig und kann nach einiger Zeit gelöscht werden. Kommentare, die in dem
Block stehen, werden niemals gelöscht  und sind eventuell wichtig für das Verständnis des Quelltextes.

2.5 Header

In Header werden Nutzdaten, ergänzende Zusatzinformationen, so genannte Metadaten, am Anfang eines Datenblocks gesetzt. Sie lassen sich mit GExperts definieren und per Tastenkürzel (Shift ⇧+Alt+T) automatisch einfügen.

2.6 Unit

Eine Unit ist eine Quelltextdatei, die separat compiliert wird.

SYNTAX 5.jpg

2.7 Procedure

SYNTAX 6.jpg

2.8 Schleifen, Anweisungen und Bedingungen

Das Begin steht in derselben Zeile wie die Anweisung/Bedingung und End steht am Anfang einer neuen Zeile.
Abfragen auf „Leer“ werden immer mit der Funktion „empty()“ abgefragt.
Abfragen auf „Nil“ werden immer mit der Funktion „assigned()“ abgefragt.
Bedingungen werden zur besseren Lesbarkeit in Klammern geschrieben.

SYNTAX 7.jpg

3. Variablen

3.1 Benennung

Variablen fangen je nach Typ immer mit folgenden Buchstaben an:



Globale Variablen -> gl
Objekte -> o
Nummerische(Float, Int) -> n
Boolean  -> l
Arrays -> a
Characters -> c
Querries -> q
TQSQL -> x...
Datenbank -> DB_...
Typen -> T

Laufvariablen werden als Buchstaben (z.B. i, j, k…) deklariert.

3.2 Deklaration

Variablen werden immer untereinander angelegt:

SYNTAX 8.jpg

4. Uses

Uses werden ebenso wie Variablen der Ordnung halber untereinander aufgelistet.

SYNTAX 9.jpg

5. Sonstiges

Die Konstruktoren Create() und Destroy() werden direkt am Anfang des Implemations-Abschnittes eingebaut.
Freigeben von Objekten mit MyFreeAndNil().
Nach Möglichkeit immer die Funktionen und Prozeduren von G_Tools benutzen.

6. SQL-Syntax-Regeln

SQL-Befehle werden komplett groß geschrieben.
SQL-Feldnamen werden komplett klein geschrieben. Bei den Befehlen


- SELECT,
- WHERE,
- AND,
- FROM,
- JOIN,
- LEFT JOIN,
- GROUP BY,
- ORDER BY,
- LIMIT,
- etc…...

wird die Zeile zur besseren Sichtigkeit umgebrochen.

SYNTAX 10.jpg

Die InitSelection ist immer Global. Ihre ID ist 10stellig.