由于我从Java切换到Kotlin,我不得不重写我的文档。 Kotlin有自己的文档格式,或者就我看来它扩展了普通的javadoc。我检查了the official documentation,其中指出有一个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
*/
这两个属性都不是IntelliJ中渲染的kdoc的一部分。
如果我将两个属性移到author
和since
之上,那么这些属性也不会显示。我不太明白为什么。 IntelliJ是否缺乏适当的kdoc支持?
答案 0 :(得分:3)
正如IntelliJ for Java在您调用类上的“显示快速文档”操作时没有为类的所有字段显示javadoc,IntelliJ for Kotlin不会显示所有属性的文档作为class quickdoc。如果您在属性上调用“显示快速文档”操作,则会显示您在@property
标记中添加的文档。