我不认为你可以; doc注释(JavaDoc和KDoc / Dokka)仅适用于以下类/方法/字段/函数/属性。
如果您真的希望他们拥有相同的文档,我认为您必须在每个项目之前重复文档注释。
尽管这是丑陋的重复,但您可以通过使用单行注释形式来避免浪费过多的空间(无论如何我还是希望对字段执行此操作):
/** List that can be associated to various media elements. */
const val MEDIA_NAME = "Media_name"
/** List that can be associated to various media elements. */
const val SONGS_IDS = "Songs_ids"
/** List that can be associated to various media elements. */
const val GENRE_IDS = "Genres_ids"
/** List that can be associated to various media elements. */
const val ARTISTS_IDS = "Artists_ids"
这当然使您有机会针对每个领域发表一些特定的观点,这将是文档的更好使用,并证明评论的合理性!
如果每个人真的无话可说,您可以通过将所有链接都链接回第一个来减少重复,例如:
/** List that can be associated to various media elements. */
const val MEDIA_NAME = "Media_name"
/** See [MEDIA_NAME] */
const val SONGS_IDS = "Songs_ids"
/** See [MEDIA_NAME] */
const val GENRE_IDS = "Genres_ids"
/** See [MEDIA_NAME] */
const val ARTISTS_IDS = "Artists_ids"
同时,同时应用于所有字段的注释可能应该是非文档注释:
// Lists that can be associated to various media elements:
…
(它当然可以使用/* … */
格式,但是//
不太可能与文档注释相混淆。)
,
您可以在 kDoc 中对元素进行分组,方法是在 code 中对其进行分组:
/**
* 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"
}
本文链接:https://www.f2er.com/3104005.html