【问题标题】:KDoc: change parameters orderKDoc:更改参数顺序
【发布时间】:2020-03-11 20:03:48
【问题描述】:

我在 Kotlin 上的 companion object 中有以下参数

    companion object Constants {
    /**
     * Values for the various type of connection that a device can have.
     */
    const val CONNECTION_KEY = "Connection_type"
    const val CONNECTION_AUX = "AUX"
    const val CONNECTION_BLUETOOTH = "Bluetooth"
    const val CONNECTION_USB = "USB"

    /**
     * Unique IDs respectively for devices and media elements.
     */
    const val DEVICE_ID_KEY = "Device_ID"
    const val MEDIA_ID_KEY = "Media_ID"

    /**
     * Various keys that you can find in [Bundle] returned by [getMediaItems].
     */
    const val MEDIA_NAME_KEY = "Media_name"
    const val SONG_IDS_KEY = "Songs_ids"
    const val GENRE_IDS_KEY = "Genres_ids"
    const val ARTIST_IDS_KEY = "Artists_ids"
}

问题是,在 Kdoc 结果中,我以 字母顺序 顺序找到它们

ARTIST_IDS_KEY

const val ARTIST_IDS_KEY: 字符串

CONNECTION_AUX

const val CONNECTION_AUX: 字符串

CONNECTION_BLUETOOTH

const val CONNECTION_BLUETOOTH: 字符串

CONNECTION_KEY

设备可以拥有的各种连接类型的值。

const val CONNECTION_KEY: 字符串

CONNECTION_USB

const val CONNECTION_USB: 字符串

DEVICE_ID_KEY

设备和媒体元素的唯一 ID。

const val DEVICE_ID_KEY: 字符串

GENRE_IDS_KEY

const val GENRE_IDS_KEY: 字符串

MEDIA_ID_KEY

const val MEDIA_ID_KEY: 字符串

MEDIA_NAME_KEY

您可以在 getMediaItems 返回的 Bundle 中找到各种键。

const val MEDIA_NAME_KEY: 字符串

SONG_IDS_KEY

const val SONG_IDS_KEY: 字符串

...有没有办法维持原来的秩序?

【问题讨论】:

    标签: kotlin kotlin-dokka kdoc


    【解决方案1】:

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

    companion object Constants {
        /**
         * Values for the various type of connection that a device can have.
         */
        object Connection {
            const val KEY = "Connection_type"
            const val AUX = "AUX"
            const val BLUETOOTH = "Bluetooth"
            const val USB = "USB"
        }
    
        /**
         * Unique IDs respectively for devices and media elements.
         */
        object IDs {
            const val DEVICE = "Device_ID"
            const val MEDIA = "Media_ID"
        }
    
        /**
         * Various keys that you can find in [Bundle] returned by [getMediaItems].
         */
        object BundleKeys {
            const val MEDIA_NAME = "Media_name"
            const val SONG_IDS = "Songs_ids"
            const val GENRE_IDS = "Genres_ids"
            const val ARTIST_IDS = "Artists_ids"   
        }
    }
    

    【讨论】:

    • 谢谢你,你在哪里很有用。你知道如何从 Java 中访问这些对象吗?
    • @Lore 您可以import packagename.OuterClass.Constants; 并使用Constants.Connection.KEY,删除companion 修饰符并使用OuterClass.Constants.Connection.KEY 或将这些嵌套对象移出伴随对象到OuterClass 并使用OuterClass.Connection.KEY .
    猜你喜欢
    • 1970-01-01
    • 1970-01-01
    • 2015-07-25
    • 1970-01-01
    • 2021-12-24
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 2021-02-13
    相关资源
    最近更新 更多