kotlin - 使用KDoc记录变量组

Question

所以我在伴随对象中有这组常量:

        /**
         * Lists that can be associated to various media elements
         */
        const val MEDIA_NAME = "Media_name"
        const val SONGS_IDS = "Songs_ids"
        const val GENRE_IDS = "Genres_ids"
        const val ARTISTS_IDS = "Artists_ids"

当我执行dokka时，与常量相关联的注释在文档中的格式不正确...如何为多个常量使用一个描述？

Answer 1

您可以通过在代码中对元素进行分组来对kDoc中的元素进行分组:

/**
 * Lists that can be associated to various media elements
 */
object Media {
    const val NAME = "Media_name"
    const val SONGS_IDS = "Songs_ids"
    const val GENRE_IDS = "Genres_ids"
    const val ARTISTS_IDS = "Artists_ids"
}