Jak často přidáváte komentáře a dokumentaci ke svému kódu?

Komentáře a dokumentace kódu by měly být pravidelně přidávány, zejména v následujících případech:

• Při psaní složité logiky, kde není zřejmé chování.
• Pro popis veřejných API, metod a tříd.
• Při použití nestandardních řešení nebo obcházek.

Pro vývoj Android se často používá JavaDoc nebo KDoc k popisu funkcí a tříd. To pomáhá ostatním vývojářům rychle pochopit účel kódu a usnadňuje údržbu.

Příklad KDoc pro funkci v Kotlinu:

/**
 * Načte údaje uživatele podle ID.
 * @param userId identifikátor uživatele
 * @return objekt User s údaji
 */
fun loadUser(userId: String): User {
    // implementace
}

Je důležité nepřidávat nadbytečné komentáře, které pouze opakují kód, ale zaměřit se na vysvětlení důvodů a kontextu.