Milyen rendszerességgel adsz hozzá megjegyzéseket és dokumentációt a kódodhoz?

A kódhoz tartozó megjegyzéseket és dokumentációt rendszeresen hozzá kell adni, különösen a következő esetekben:

• Bonyolult logika írásakor, ahol a viselkedés nem nyilvánvaló.
• Nyilvános API-k, metódusok és osztályok leírására.
• Nem szabványos megoldások vagy kerülőutak alkalmazásakor.

Az Android fejlesztés során gyakran használják a JavaDoc vagy KDoc dokumentációs stílusokat a funkciók és osztályok leírására. Ez segít más fejlesztőknek gyorsan megérteni a kód célját, és megkönnyíti a karbantartást.

Kotlin példaként egy KDoc a függvényhez:

/**
 * Felhasználói adatok betöltése ID alapján.
 * @param userId a felhasználó azonosítója
 * @return User objektum az adatokkal
 */
fun loadUser(userId: String): User {
    // implementáció
}

Fontos, hogy ne írjunk túl sok kommentárt, ami csak ismétli a kódot, hanem inkább a magyarázatokra és a kontextusra fókuszáljunk.