Почему TODO можно указать у любого типа?

Обзор механизма TODO в Kotlin

В Kotlin ключевое слово TODO() — это не просто аннотация или комментарий, а специальная стандартная функция из библиотеки Kotlin (kotlin-stdlib). Она объявлена следующим образом:

/**
 * Always throws [NotImplementedError] stating that operation is not implemented.
 */
public inline fun TODO(): Nothing = throw NotImplementedError()

/**
 * Always throws [NotImplementedError] stating that operation is not implemented.
 * @param reason a string explaining why the implementation is missing.
 */
public inline fun TODO(reason: String): Nothing = throw NotImplementedError(reason)

Почему TODO() можно вызывать для любого типа

Ключевой момент лежит в типе возвращаемого значения функции TODO() — это Nothing.

Тип Nothing в Kotlin

Nothing — это особый тип в системе типов Kotlin, имеющий несколько уникальных свойств:

• Он представляет собой тип, который никогда не имеет реального значения. Функция, возвращающая Nothing, всегда завершается исключением (или, в теории, бесконечным циклом).
• В иерархии типов Kotlin Nothing является подтипом всех других типов (subtype of all types). Это формальный "нижний" (bottom) тип в теории типов.

Это значит, что с точки зрения системы типов Kotlin выражение типа Nothing может быть использовано в любом контексте, где ожидается любой другой тип (String, Int, List<Any>, YourCustomClass), потому что Nothing является его подтипом.

Примеры использования

// 1. Возвращаемый тип функции — String
fun getUserName(): String {
    TODO("Integrate with Auth API")
    // Компилятор считает, что здесь возвращается String,
    // потому что TODO() возвращает Nothing, который является подтипом String.
}

// 2. Значение переменной типа Int
val calculatedValue: Int = TODO("Calculate complex formula")

// 3. Элемент списка типа List<Person>
val peopleList: List<Person> = listOf(
    Person("Alice"),
    TODO("Add Bob from database"), // Здесь ожидается Person, а Nothing — подтип Person
    Person("Charlie")
)

// 4. В ветвях условных операторов
fun parseInput(input: String): Result {
    return when (input) {
        "yes" -> Result.Success
        "no" -> Result.Failure
        else -> TODO("Handle edge cases") // Ожидается тип Result
    }
}

Практическая ценность и отличие от комментария

Этот механизм дает значительные преимущества по сравнению с обычными комментариями // TODO:

1. Контроль времени компиляции: Код с TODO() является синтаксически корректным и компилируется, позволяя собирать и тестировать проект даже с незавершенными частями.
2. Явное указание на нереализованность: Любой вызов TODO() гарантированно приведет к NotImplementedError при выполнении. Это предотвращает случайное использование неготового функционала.
3. Безопасность и обязательность: Комментарий можно забыть или игнорировать, а нереализованная функция TODO() обязательно "заявит" о себе при первом запуске, делая процесс разработки более дисциплинированным.
4. Интеграция с инструментами: IDE (IntelliJ IDEA, Android Studio) часто имеют специальную поддержку для функции TODO(), подсвечивая ее в коде и включая в списки задач.

Важные предостережения

• Не для production: TODO() — исключительно инструмент разработки. Любой вызов этой функции в рабочем коде приведет к crash при выполнении.
• Тип Nothing уникален: Его нельзя использовать как обычный класс. Это специальный тип, существующий только для описания "несуществующих" значений и контроля потока выполнения (например, функция fail() также может возвращать Nothing).

Таким образом, возможность указать TODO() для любого типа — это следствие фундаментального свойства типа Nothing быть подтипом всех типов в Kotlin, что превращает эту функцию в мощный и типобезопасный инструмент для маркирования незавершенных участков кода во время разработки.