Megközelítések

Minden feladathoz tartozhatnak megközelítések, amelyek leírják, hogyan lehet egy feladatot többféleképpen megoldani.

Megközelítés

Egy megközelítés azt mutatja be, hogyan lehet egy feladatot egy adott módon megoldani.

• A tartalma az alábbiak egyike legyen:
  • Egy idiomatikus megközelítést mutat be
  • Egy nem idiomatikus, de érdekes megközelítést mutat be
• Egy (teljes) kódpéldával kezdődjön
  • A dokumentum további részében bátran használj kódpéldákat
• Nyugodtan mélyülj el a témában
• Hivatkozz hasznos forrásokra (például dokumentációra)
• A snippetnek a megközelítés lényegét kell bemutatnia
  • Legfeljebb 8 sor használható

Ha különböző megközelítéseket szeretnél összehasonlítani, írj egy cikket.

A megközelítések áttekintése

• Add meg a probléma kontextusát
  • Írd le azokat a fontos pontokat (például buktatókat), amelyek minden megközelítésre érvényesek
• Tárgyald meg a legidiomatikusabb megközelítéseket
• Minden megközelítés olyan snippettel kezdődjön, amely bemutatja a megközelítést
• A tartalom maradjon inkább magas szintű
  • A részletes információk önálló megközelítésoldalra kerüljenek
  • További információért hivatkozz az önálló megközelítésoldalra
• Tárgyald meg, hogyan válassz a megközelítések közül
  • Mik az előnyök és a hátrányok?
  • Van olyan megközelítés, amely jobban illik bizonyos felhasználási esetekhez?

Általános szempontok

• Egyes nyelvekben ugyanazt a dolgot többféleképpen is le lehet írni. Ha bizonyos szintaxis csak a nyelv újabb verzióiban érhető el, fontold meg a „régi” szintaxis használatát. Így nagyobb az esélye, hogy a tanulók megértik a kódot.
  • Az alternatív szintaxist a megközelítés dokumentumában mutathatod be
• Ha a nyelvedhez van ajánlott stílusútmutató, kövesd annak irányelveit (ahol lehetséges)

Milyen feladatokhoz írj megközelítéseket?

Általánosságban a gyakorlófeladatokhoz érdemesebb megközelítéseket írni, mert ezeket általában többféleképpen is meg lehet oldani.

A tanulófeladatoknál érdekes lehet a mintamegoldás megközelítésének tárgyalása. Bemutathatod például, hogy a tanított fogalom hogyan teszi könnyebbé bizonyos kód megírását.

Fájlok

Minden megközelítéshez a következő két fájlt kell hozzáadni:

• .approaches/<approach-slug>/content.md: a megközelítés leírása (lásd a dokumentációt)
• .approaches/<approach-slug>/snippet.txt: a megközelítést bemutató snippet (lásd a dokumentációt)

Ezután hozzá kell adnod vagy frissítened kell:

• .approaches/config.json: a megközelítések metaadatai (lásd a dokumentációt)

A snippet kiterjesztésének beállítása

A .txt alapértelmezett kiterjesztés helyett egyéni kiterjesztést is használhatsz, ha beállítod az approaches.snippet_extension mezőt a kurzusod config.json fájljában. Ha be van állítva, a hozzáadandó snippetfájl neve .approaches/<approach-slug>/snippet.<approaches.snippet_extension> kell legyen.