Benennungen

Um die Dateien und Ordner systematisch zu bennenen gibt es folgende Grundsätze:

  1. Systemdateien sind auf Englisch und in Kleinschreibweise benannt.

  2. Haupt-Quelltextdateien in einem Abschnittsordner heissen immer index.rst.

  3. Sonst gilt das Modified Pascal Case-Schema zur Bennenung. Es trennt Wortbestandteile durch Groß- und Kleinschreibung bzw. Bindestriche.

Modifizierter „Pascal Case“

(Modified Pascal Case, MPC, Version 2.1)

  1. Kleinbuchstaben: Grundsätzlich werden Kleinbuchstaben verwendet.

  2. Trennung durch Großschreibung: Der erste Buchstabe eines beliebigen Wortes wird groß geschrieben, wodurch die Worttrennung angezeigt wird.

  3. Trennung durch Bindestrich zur Gruppierung: Wenn eine zusätzliche spezielle Trennung erforderlich ist (Gruppierung, Präfixe, Postfixes…), ist ein Bindestrich („-“) zu verwenden (z. B. Memo-DoNotUseYellowPencils).

  4. Trennung durch Bindestrich wenn Großschreibung nicht möglich: Bei Zahlen, oder wenn die Großschreibung nicht möglich ist, wird als Trenzeichen ein Bindestrich (-) verwendet. Dies gilt auch für die Trennung zwischen einem Wort und einer Zahl oder einer Zahl und einem Wort.

  5. Akronyme sind Wörter: Akronyme werden wie normale Wörter behandelt (z. B. „Uno“, „Nato“ usw.).

  6. Keine Leerzeichen: Es werden keine Leerzeichen verwendet.

Zum Beispiel:

  • 2018-04-01-Memo-HowToUseTheModifiedPascalCaseAtTheUn-Draft-1.rst