Z jaką regularnością dodajesz komentarze i dokumentację do swojego kodu?

Komentarze i dokumentacja kodu powinny być regularnie dodawane, szczególnie w następujących przypadkach:

• Przy pisaniu złożonej logiki, gdzie zachowanie nie jest oczywiste.
• Do opisu publicznych API, metod i klas.
• Przy korzystaniu z niestandardowych rozwiązań lub obejść.

Dla rozwoju Android często używa się JavaDoc lub KDoc do opisu funkcji i klas. Pomaga to innym programistom szybko zrozumieć cel kodu i ułatwia utrzymanie.

Przykład KDoc dla funkcji w Kotlin:

/**
 * Ładuje dane użytkownika po ID.
 * @param userId identyfikator użytkownika
 * @return obiekt User z danymi
 */
fun loadUser(userId: String): User {
    // implementacja
}

Ważne jest, aby nie pisać nadmiarowych komentarzy, które po prostu powtarzają kod, lecz skupić się na wyjaśnieniu przyczyn i kontekstu.