Coding Guideline¶

• QFQ General: http://docs.qfq.io/en/master/CodingGuideline.html
• I-MATH
  • Tabelle:
    • Name: Camel case, erster Buchstabe gross , kein Underscore. Bsp: FormElement
    • Im ERD sollte bei jeder Tabelle auch die zu verwendende Abkürzung genannt werden. Bsp: FormEelement - fe
    • Sind in
  • Spalten:
    • Name: Camel case, erster Buchstabe klein , kein Underscore. Bsp: formId
    • Erste Spalte: id, Primary Key.
    • Vorletzte Spalte: created, datetime, default: current timestamp
    • Letzte Spalte: modified, datetime, default: current timestamp, on update current timestamp
    • Wird auf einen Primary Key einer anderen Tabelle verwiesen, ergibt sich der Name aus <Kuerzel><Id>. Bsp: pId.
      • 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 .
  • Formular
    • Name: Camel case, erster Buchstabe klein , kein Underscore. Bsp: formElement
    • Sind in einer Instanz mehrere Tools, sollten die Forms anhand eines Prefixes unterschieden werden. Bsp dissReview, maReview.
  • Spalte 'reference'
    • 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
  • BPMN
    • Zeichnung via DrawIO
  • ERD
    • Zeichnung via DrawIO