如何使用KDoc正确标注变量？@property注解不被Dokka识别如何解决

KDoc 中的 @property 标签仅支持写在类/接口/枚举的顶层KDoc块中，若直接将该标签写在单个属性上方的独立注释块里，Dokka会直接忽略该标签内容。两种符合规范的标注方式如下：

写法1：单个属性上方加独立KDoc注释（更推荐） #

直接在需要标注的属性、枚举常量上方写注释内容即可，无需加额外标签，Dokka识别优先级最高，针对你的枚举类示例写法如下：

/**
 * 蔬菜类型枚举
 */
enum class Vegetables(
    /**
     * 蔬菜类型的唯一标识ID
     */
    val id: Int
) {
    /**
     * 土豆，对应ID为1
     */
    POTATO(1),
    /**
     * 胡萝卜，对应ID为2
     */
    CARROT(2),
    /**
     * 黄瓜，对应ID为3
     */
    CUCUMBER(3)
}

写法2：类顶层KDoc中使用@property标签统一标注 #

如果需要将类的所有属性注释统一放在类头部，可以在顶层KDoc块中使用@property 属性名 注释内容的格式标注，示例如下：

/**
 * 蔬菜类型枚举
 * @property id 蔬菜类型的唯一标识ID
 */
enum class Vegetables(val id: Int) {
    /**
     * 土豆，对应ID为1
     */
    POTATO(1),
    /**
     * 胡萝卜，对应ID为2
     */
    CARROT(2),
    /**
     * 黄瓜，对应ID为3
     */
    CUCUMBER(3)
}

注意事项 #

• 枚举常量的注释仅支持写独立注释块，无法通过类顶层的@property标签标注
• 若同一属性同时使用两种方式标注，Dokka会优先读取属性上方独立注释块的内容
• 不要在单个属性的独立注释块中添加@property标签，该写法不符合KDoc规范

内容的提问来源于stack exchange，提问作者Aital Egorov