Документирование свойств класса в Kotlin
Поскольку я перешел с Java на Kotlin, мне пришлось переписать свои документы. У Kotlin есть собственный формат документации или, более того, он расширяет обычные javadocs, насколько я понимаю. Я проверил официальная документация, в котором указано, что существует тег 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
*/
оба свойства не являются частью визуализированного kdoc в IntelliJ.
Если я переместу два свойства выше author и since, они также не будут отображаться. Не совсем понимаю почему. Это IntelliJ не имеет надлежащей поддержки kdoc?
class Player (var playerName: String, var playerScore: Int) ... но я думаю, что ответа @yole достаточно, если он правильный, что я проверю позже.
Ответы 1
Подобно тому, как IntelliJ для Java не показывает вам javadocs для всех полей класса, когда вы вызываете действие «Показать быструю документацию» в классе, IntelliJ для Kotlin не показывает документы для всех свойств как часть класса quickdoc. Документы, добавленные вами в теги @property, будут показаны, если вы активируете действие «Показать быструю документацию» для свойства.
playerNameиplayerScoreобъявлены как класс внутри или как его параметры, как в примере?