A dokumentáció három közönségnek szól: a felhasználónak (hogyan használja), a fejlesztőnek vagy értékelőnek (hogyan épül fel), és a jövőbeli önmagadnak (miért döntöttél így). A kód maga a legpontosabb leírás, de nem mond el mindent. A jó komment a miért kérdésre válaszol, nem arra, mit csinál a sor (azt a kód is megmutatja).

Az XML-dokumentációs komment (///) a metódusok, osztályok és tulajdonságok leírása, amelyet a Visual Studio az IntelliSense ablakban is megjelenít, amikor a metódus nevére állsz. Ha a metódus fölé három törtvonalat (///) írsz, a Visual Studio magától kiegészíti a vázat:

/// <summary>
/// Elmenti a teendőt: új teendőnél (Id == 0) beszúrja, egyébként módosítja.
/// </summary>
/// <param name="t">A mentendő teendő. A <c>Hiba()</c> ellenőrzésen át kell mennie.</param>
/// <returns>A teendő azonosítója (új teendőnél az újonnan kapott).</returns>
/// <exception cref="ArgumentException">Ha az adatok hibásak.</exception>
/// <exception cref="InvalidOperationException">Ha a módosítandó teendő már nem létezik.</exception>
public static int Mentes(Teendo t)
{
    // ...
}

Gondold végig!

Mikor nem kell kommentet írni egy kódsorhoz, és mi lehet a jobb megoldás a komment helyett?

A README az első fájl, amelyet valaki a projektedben megnyit. Néhány perc alatt meg kell válaszolnia: mi ez, mire jó, hogyan indítom el, és mi van benne? Általában README.md a neve: az .md a Markdown formátumot jelzi, egy egyszerű jelölőnyelvet, amelyet sima szövegként is lehet olvasni, de sok program formázva jelenít meg. A leggyakoribb jelölések:

# Teendőlista

Egyszerű Windows Forms program teendők kezelésére: felvétel, módosítás,
törlés, szűrés, keresés és a lejárt határidők kiemelése.

![Főablak](kepek/fo-ablak.png)

## Funkciók

- Teendők felvétele címmel, leírással, határidővel és fontos jelöléssel
- Kész/nyitott állapot jelölése
- Szűrés állapot szerint, keresés a címben és a leírásban
- A lejárt, nyitott teendők pirossal látszanak

## Futtatás

1. Csomagold ki a `Teendolista_1.0.0.zip` fájlt egy tetszőleges mappába.
2. Indítsd a `Teendolista.exe` fájlt.
3. Szükséges: Windows 10 vagy újabb, .NET Framework 4.7.2 (a Windows 10 már tartalmazza).

## Az adatok

Az adatok a `teendok.db` SQLite fájlban vannak, a program mappájában.
Biztonsági mentéshez másold a fájlt másik helyre.

## Ismert hibák és korlátok

- Egyszerre egy felhasználó használja (nincs hálózati mód).
- Az ékezetek nélküli keresés nem támogatott.

## Készítő és verzió

Készítette: Minta Anna, 2026. Verzió: 1.0.0 (lásd: CHANGELOG.md)
A program a System.Data.SQLite csomagot használja.

A jó README mérőszáma

Adj egy kezdőnek egy üres gépet és a README fájlt. Ha magyarázat nélkül el tudja indítani és ki tudja próbálni a programot, jó a README. Ha rákérdez valamire, azt a választ írd bele a fájlba.

A felhasználó nem a programozásra kíváncsi, hanem arra, hogyan érje el a célját. Ezért az útmutató feladatok szerint épül fel („Hogyan veszek fel új teendőt?”), nem a gombok és menük listája szerint. Minden feladat: címsor, 3–7 számozott lépés, és ahol kell, egy képernyőkép. A lépések felszólító módban, rövid mondatokban szólnak: Kattints az Új gombra.

A fejlesztői dokumentáció annak szól, aki át akarja venni a programot (egy társ, vagy te, fél év múlva). Nem kell hosszú, de legyen benne az, amit a kódból nehéz kiolvasni:

Ne a kódot másold a dokumentációba

A dokumentációba kerülő kódrészletek elavulnak, amint a kód változik. Inkább írd le a szerkezetet és a döntéseket, és hivatkozz az osztályokra a nevükkel. Ami a kódban van, azt a kód mutassa; a dokumentáció a kód mögötti gondolatot rögzítse.

A kiadási csomag az, amit átadsz valakinek. A tapasztalat szerint a leggyakoribb hiba, hogy a program a te gépeden működik, de másén nem, mert elfelejtettél valamit mellékelni. A lépések:

1. Állítsd a fordítási módot Release-re (a Visual Studio eszköztárában Debug helyett Release), és építsd újra a projektet (Ctrl+Shift+B).
2. Nyisd meg a projekt bin/Release mappáját (a Fájlkezelőben, a 0.5 lecke szerint).
3. Másold egy új mappába a teljes tartalmat: az .exe fájlt, a .dll fájlokat (például a System.Data.SQLite.dll és a hozzá tartozó x86/x64 mappák), a .db adatbázist és a .config fájlt.
4. Tedd mellé a README.md, a felhasználói útmutató és a CHANGELOG.md fájlt. A .pdb fájlokat nem kell mellékelni (hibakeresési adatok).
5. Tömörítsd zip fájlba, és a nevébe írd a verziót: Teendolista_1.0.0.zip.
6. Próbáld ki egy tiszta környezetben: csomagold ki egy másik mappába (vagy másik gépen), és indítsd el. Ez az utolsó, legfontosabb lépés.

Gondold végig!

Miért nem elég tesztelni a programot a Visual Studióból indítva (F5), ha át akarod adni? Mi lehet, ami a te gépeden működik, a másikén nem?

Verziószám és változásnapló

A verziószám három részből áll: FŐ.ALSÓ.JAVÍTÁS (például 1.2.3). A számokat így növeld:

# Változásnapló

## 1.1.0 – 2026-11-15
- Új: határidő nélküli teendők kezelése
- Új: a lejárt teendők pirossal látszanak
- Javítva: a kész teendők törlése nem kért megerősítést

## 1.0.0 – 2026-10-30
- Első kiadás: felvétel, módosítás, törlés, szűrés, keresés

A verziószámot a Visual Studióban a projekt tulajdonságainál (Properties → Application → Assembly Information) is megadhatod, így a program .exe fájljának tulajdonságai között is látszik. Verziókezelésre a nagyobb projekteknél a Git való: ez a tanfolyam nem tanítja, de ha eljutsz odáig, érdemes megtanulni. Addig a rendszeres, dátumozott zip-mentés (projekt_20261026.zip) is megteszi.

Egy jó bemutató nem a program minden gombját mutatja meg, hanem egy történetet mesél: milyen problémát old meg, hogyan működik, és mit tanultál közben. Öt perc kevés idő, ezért a szerkezet legyen szigorú:

A hibakezelés bemutatása meggyőző

Sok bemutató csak azt mutatja, hogy a program működik, ha mindent jól csinálunk. Az igazán meggyőző az, amikor szándékosan hibás adatot írsz be, és a program érthetően reagál. Ez mutatja meg, hogy gondoltál a valódi felhasználóra.

Reflexió: mit tanultál?

A projekt végén írj rövid reflexiót (egy oldal). Ez nemcsak a programozás tanulásában segít, hanem a tanári pályán is hasznos: a saját tanulásod tudatos elemzése az egyik legjobb módszer a fejlődésre és a tanulók tanítására.

Három szinten gyakorolhatsz: alap, közepes és kihívás. Csak a próbálkozás után nyisd le a megoldást.

Alap szint

/// <summary>
/// Törli a megadott azonosítójú teendőt az adatbázisból.
/// </summary>
/// <param name="id">A törlendő teendő azonosítója.</param>
/// <returns>Igaz, ha a teendőt törölte; hamis, ha nincs ilyen azonosítójú teendő.</returns>
public static bool Torles(int id)

Közepes szint

Kihívás szint

## 1.2.1 – 2026-11-20
- Javítva: a „Kész” szűrő a nyitott teendőket is mutatta

Gyors önellenőrzés

Válaszolj fejben, és csak utána nyisd le a választ.