Coding Guideline » History » Version 4
Carsten Rose, 05.11.2022 20:23
1 | 1 | Carsten Rose | h1. Coding Guideline |
---|---|---|---|
2 | |||
3 | |||
4 | * QFQ General: http://docs.qfq.io/en/master/CodingGuideline.html |
||
5 | * I-MATH |
||
6 | |||
7 | * Tabelle: |
||
8 | |||
9 | * *Name*: Camel case, erster Buchstabe *gross* , kein Underscore. Bsp: @FormElement@ |
||
10 | 4 | Carsten Rose | * Im ERD sollte bei jeder Tabelle auch die zu verwendende Abkürzung genannt werden. Bsp: @FormElement - fe@ |
11 | 1 | Carsten Rose | * Sind in |
12 | |||
13 | * Spalten: |
||
14 | |||
15 | * *Name*: Camel case, erster Buchstabe *klein* , kein Underscore. Bsp: @formId@ |
||
16 | * *Erste Spalte*: @id@, Primary Key. |
||
17 | * *Vorletzte Spalte*: @created@, datetime, default: current timestamp |
||
18 | * *Letzte Spalte*: @modified@, datetime, default: current timestamp, on update current timestamp |
||
19 | * Wird auf einen Primary Key einer anderen Tabelle verwiesen, ergibt sich der Name aus <Kuerzel><Id>. Bsp: @pId@. |
||
20 | |||
21 | * Gibt es in einer Tabelle a) mehrere Spalten auf die gleiche Fremdtabelle (und muessen daher unterschiedlich sein) oder b) soll der Spaltenamen klarer beschreiben, kann eine Spezifizierung angehängt werden. Bsp: @pIdApplicant@, @pIdHead@. _Auf jeden Fall steht das @pId@ am Anfang_ . |
||
22 | |||
23 | * Formular |
||
24 | |||
25 | * *Name*: Camel case, erster Buchstabe *klein* , kein Underscore. Bsp: @formElement@ |
||
26 | * Sind in einer Instanz mehrere Tools, sollten die Forms anhand eines Prefixes unterschieden werden. Bsp @dissReview@, @maReview@. |
||
27 | |||
28 | * Spalte 'reference' |
||
29 | |||
30 | 2 | Carsten Rose | * *Name*: Als Vorbereitung um unterschiedliche Tools aus verschiedenen Instanzen mergen zu koennen, wird empfohlen die Referenz Records mit einem eindeutigen Prefix zu versehen. Bsp: @my_exercise_group@ |
31 | 3 | Carsten Rose | |
32 | * BPMN |
||
33 | |||
34 | * Zeichnung via DrawIO |
||
35 | |||
36 | * ERD |
||
37 | |||
38 | * Zeichnung via DrawIO |