¿Con qué regularidad añades comentarios y documentación a tu código?

Los comentarios y la documentación del código deben añadirse regularmente, especialmente en los siguientes casos:

• Al escribir lógica compleja, donde el comportamiento no es evidente.
• Para describir API públicas, métodos y clases.
• Al usar soluciones no estándar o caminos alternativos.

Para el desarrollo en Android, a menudo se utiliza JavaDoc o KDoc para describir funciones y clases. Esto ayuda a otros desarrolladores a entender rápidamente el propósito del código y facilita el mantenimiento.

Ejemplo de KDoc para una función en Kotlin:

/**
 * Carga los datos del usuario por ID.
 * @param userId identificador del usuario
 * @return objeto User con los datos
 */
fun loadUser(userId: String): User {
    // implementación
}

Es importante no escribir comentarios excesivos que simplemente repitan el código, sino centrarse en explicar las razones y el contexto.