Писал ли документацию

«Писал ли документацию» — вопрос из категории Софт-скиллы, который задают на 23% собеседований Android Разработчик. Ниже — развёрнутый пример ответа, который можно адаптировать под свой опыт.

Ответ

Да, писал документацию для проектов. Это важно для поддержки кода и командной работы.

Пример:

/**
 * Функция для валидации email.
 * @param email Строка для проверки.
 * @return true, если email валиден, иначе false.
 */
fun isValidEmail(email: String): Boolean {
    return Patterns.EMAIL_ADDRESS.matcher(email).matches()
}

Использую:

  • KDoc для Kotlin/Java
  • Markdown для README и гайдов
  • Swagger для API (если нужно)

Документирую архитектуру, ключевые классы, публичные методы. Стараюсь делать её лаконичной и полезной.