Как документировать атрибуты в классе данных Kotlin?

Question

Где мне разместить Javadoc для атрибутов в классе данных Kotlin?

Другими словами, как написать в Kotlin следующий код Java:

/**
 * Represents a person.
 */
public class Person {
    /**
     * First name. -- where to place this documentation in Kotlin?
     */
    private final String firstName;
    /**
     * Last name. -- where to place this documentation in Kotlin?
     */
    private final String lastName;

    // a lot of boilerplate Java code - getters, equals, hashCode, ...
}

В Котлине это выглядит так:

/**
 * Represents a person.
 */
data class Person(val firstName: String, val lastName: String)

но где разместить документацию атрибутов?

Answer 1

Как описано в документации, вы можете использовать @property тег для этого:

/**
 * Represents a person.
 * @property firstName The first name.
 * @property lastName The last name.
 */
data class Person(val firstName: String, val lastName: String)

В качестве альтернативы просто укажите имена свойств в описании класса, если вам нечего сказать о них в документации:

/**
 * Represents a person, with the given [firstName] and [lastName].
 */
data class Person(val firstName: String, val lastName: String)