Platzhalter#

In diesem Abschnitt wird erklärt, wie Platzhaltervariablen in Befehlen und Codebeispielen formatiert werden soll.

Platzhalter in Beispielcode und Befehlen stellen Werte dar, die beim Verwenden des Codes ersetzt werden müssen. Platzhalter in Beispielausgaben können die Werte auch variieren. Im Allgemeinen hat ein Platzhalter einen beschreibenden Namen als Standardwert.

Der Platzhalter PROJECT_ID steht für eine beispielhafte Projektbezeichnung, die mit PROJECT_ beginnt, gefolgt von einer variablen ID.

Beim Platzhalter HTTP_RESPONSE_CODE wird signalisiert, dass ein HTTP-Antwortcode zwischen 100 und 599 erwartet wird.

Text für Platzhaltervariablen#

  • Verwendet Großbuchstaben mit Unterstrich als Trennzeichen.

    • ✅ https://cusy.io/LANGUAGE_CODE/

    • ❌ https://cusy.io/LANGUAGE_CODE/

    • ❌ https://cusy.io/language-code/

    • ❌ https://cusy.io/LanguageCode/

  • Wenn der Kontext, in dem ihr Platzhaltervariablen verwenden wollt, Großbuchstaben und Unterstriche missverständlich sein können, dann verwendet etwas anderes, aber seid intern konsistent.

  • Verwendet keine Possessivpronomen in Platzhaltern.

    • ❌ https://cusy.io/MY_LANGUAGE/

    • ❌ https://cusy.io/YOUR_LANGUAGE/

Erläutert Platzhalter#

Wenn ihr einen Platzhalter in Text oder Code verwendet, fügt bei der ersten Verwendung eine Erklärung für den Platzhalter ein. Wenn nach der Verwendung dieses Platzhalters noch weitere Schritte und andere Platzhalter folgen, könnt ihr sie auch alle auf einmal erklären.

Verwendet bei Prozeduren die folgende Reihenfolge:

  1. Erklärt, was gemacht werden soll

  2. Nennt den Befehl

  3. Erläutert den Platzhalter

  4. Erläutert den Befehl bei Bedarf ausführlicher

  5. Führt die Ausgabe auf, falls erforderlich

  6. Erläutert ggf. die Ausgabe

  • ✅

    1. Damit euch die Spack-Umgebung zur Verfügung steht, müsst ihr folgendes in die ~/.bashrc oder ~/.profile eingetragen:

      export SPACK_ROOT=~/spack
. $SPACK_ROOT/share/spack/setup-env.sh

    2. SPACK_ROOT gibt dabei den Pfad zu eurer Spack-Installation an.

      . definiert den Pfad zur Datei setup-env.sh, wodurch ihr zukünftig die Spack-Befehle direkt in eurer Konsole aufrufen könnt.

    3. Die geänderte Konfiguration wird nun übernommen mit source, z.B. mit:

      $ source ~/.bashrc

    4. Schließlich könnt ihr eure Shell-Konfiguration überprüfen, z.B.:

      $ spack compiler find
==> Found no new compilers
==> Compilers are defined in the following files:
    /Users/veit/.spack/darwin/compilers.yaml

    5. spack konnte direkt im Pfad aufgerufen werden und auch die Direktive compiler war verfügbar. Damit sind die Pfadangaben in der Shell-Konfiguration richtig und wirksam.

Siehe auch