在 Kotlin 中记录类属性

Mar*_*cel 1 java documentation javadoc kotlin

自从我从 Java 切换到 Kotlin 后,我不得不重写我的文档。Kotlin 有自己的文档格式,或者就我所见,它扩展了普通的 javadoc。我检查了官方文档,其中指出有一个property标签可以让您记录类属性。

如果我有一个看起来像这样的 kdoc:

/**
 * Tablemodel for the Players of a server, only holds two properties:
 *
 *  * Name
 *  * Score
 *
 * @author marcel
 * @since Jan 10, 2018
 * @property playerName Ingame name of the player
 * @property playerScore Ingame score of the player
 */
Run Code Online (Sandbox Code Playgroud)

这两个属性都不是 IntelliJ 中呈现的 kdoc 的一部分。

如果我移动author和上面的两个属性since,它们也不会显示。我不太明白为什么。IntelliJ 是否缺乏适当的 kdoc 支持?

yol*_*ole 5

正如 Java 的 IntelliJ 在您调用类上的“显示快速文档”操作时不会向您显示类的所有字段的 javadoc 一样,Kotlin 的 IntelliJ 不会将所有属性的文档显示为类 quickdoc 的一部分。@property如果您对属性调用“显示快速文档”操作,则会显示您在标签中添加的文档。