Com que regularidade adiciona comentários e documentação ao seu código?

Comentários e documentação do código devem ser adicionados regularmente, especialmente nos seguintes casos:

• Ao escrever lógica complexa, onde o comportamento não é óbvio.
• Para descrever APIs públicas, métodos e classes.
• Ao usar soluções não padrão ou caminhos alternativos.

Para desenvolvimento Android, frequentemente usam-se JavaDoc ou KDoc para descrever funções e classes. Isso ajuda outros desenvolvedores a entender rapidamente o propósito do código e facilita a manutenção.

Exemplo de KDoc para uma função em Kotlin:

/**
 * Carrega os dados do usuário pelo ID.
 * @param userId identificador do usuário
 * @return objeto User com os dados
 */
fun loadUser(userId: String): User {
    // implementação
}

É importante não escrever comentários excessivos que apenas repetem o código, mas focar em explicar as razões e o contexto.