Ako často pridávate komentáre a dokumentáciu k svojmu kódu?

Komentáre a dokumentácia kódu by sa mali pravidelne pridávať, najmä v týchto prípadoch:

• Pri písaní zložitej logiky, kde správanie nie je zrejmé.
• Na opis verejných API, metód a tried.
• Pri používaní nestandardných riešení alebo obchádzok.

Pre vývoj Android sa často používajú JavaDoc alebo KDoc na opis funkcií a tried. To pomáha ostatným vývojárom rýchlo pochopiť účel kódu a uľahčuje údržbu.

Príklad KDoc pre funkciu v Kotlin:

/**
 * Načíta údaje používateľa podľa ID.
 * @param userId identifikátor používateľa
 * @return objekt User s údajmi
 */
fun loadUser(userId: String): User {
    // implementácia
}

Je dôležité nepisovať nadbytočné komentáre, ktoré iba opakujú kód, ale zamerať sa na vysvetlenie dôvodov a kontextu.