Lösungsansätze

Zu jeder Übung können Ansätze gehören, die beschreiben, auf welche verschiedenen Weisen sich eine Übung lösen lässt.

Ansatz

Ein Ansatz sollte untersuchen, wie sich eine Übung auf eine bestimmte Weise lösen lässt.

• Sein Inhalt sollte entweder:
  • einen idiomatischen Ansatz untersuchen
  • einen nicht idiomatischen, aber interessanten Ansatz untersuchen
• mit einem (vollständigen) Codebeispiel beginnen
  • im Rest des Dokuments großzügig Codebeispiele verwenden
• gerne tief in das Thema eintauchen
• auf nützliche Ressourcen verlinken (z. B. Dokumentation)
• Das Snippet sollte den Kern des Ansatzes zeigen
  • Es dürfen höchstens 8 Zeilen verwendet werden

Wenn du verschiedene Ansätze vergleichen möchtest, schreib bitte einen Artikel.

Überblick über die Ansätze

• Gib Kontext zum Problem
  • Beschreibe wichtige Punkte (z. B. Stolperfallen), die für alle Ansätze gelten
• Besprich die idiomatischsten Ansätze
• Jeder Ansatz sollte mit einem Snippet beginnen, das den Ansatz veranschaulicht
• Halte die Inhalte eher allgemein
  • Detaillierte Informationen gehören auf eine eigenständige Ansatz-Seite
  • Verlinke für mehr Informationen auf die eigenständige Ansatz-Seite
• Besprich, wie du dich zwischen den Ansätzen entscheidest
  • Welche Vor- und Nachteile gibt es?
  • Eignen sich manche Ansätze besser für bestimmte Anwendungsfälle?

Allgemeine Hinweise

• In manchen Sprachen gibt es verschiedene Wege, dasselbe zu schreiben. Wenn ein Teil dieser Syntax erst in neueren Versionen der Sprache verfügbar ist, solltest du die „alte“ Syntax in Betracht ziehen. So ist es wahrscheinlicher, dass die Lernenden den Code verstehen.
  • Alternative Syntax kannst du im Dokument des Ansatzes zeigen
• Wenn es für deine Sprache einen empfohlenen Styleguide gibt, folge diesen Richtlinien (soweit möglich)

Für welche Übungen solltest du Ansätze schreiben?

Im Allgemeinen eignen sich Praxisübungen besser dafür, Ansätze zu schreiben, weil sie sich meist auf mehrere Arten lösen lassen.

Bei Konzeptübungen kann es interessant sein, den Ansatz der Musterlösung zu besprechen. Du könntest zum Beispiel zeigen, wie das vermittelte Konzept das Schreiben von bestimmtem Code erleichtert.

Dateien

Jeder Ansatz muss die folgenden zwei Dateien hinzufügen:

• .approaches/<approach-slug>/content.md: Beschreibung des Ansatzes (siehe die Dokumentation)
• .approaches/<approach-slug>/snippet.txt: Snippet, das den Ansatz veranschaulicht (siehe die Dokumentation)

Danach musst du noch Folgendes hinzufügen oder aktualisieren:

• .approaches/config.json: Metadaten für die Ansätze (siehe die Dokumentation)

Die Snippet-Erweiterung konfigurieren

Du kannst auch eine eigene Dateiendung statt der Standardendung .txt verwenden, indem du das Feld approaches.snippet_extension in der config.json-Datei deines Tracks setzt. Wenn es gesetzt ist, muss die Snippet-Datei, die du hinzufügen musst, .approaches/<approach-slug>/snippet.<approaches.snippet_extension> heißen.