使用 KDoc 记录 Ktor 路由

Posted 2023-04-15

【中文标题】使用 KDoc 记录 Ktor 路由

【英文标题】：Documenting Ktor routes with KDoc

【发布时间】：2019-05-12 01:10:03

【问题描述】：

有谁知道记录 Ktor 路线的正确方法是什么，旨在将其显示在 KDoc 上？ 示例：

route(DogoBot.data.API.ROUTE)
    route("token")
        route("add")
            get("fromdiscord")  ... 
            get  ... 
        
    
    route("user")
        route("id") 
            get  ... 
        
    
    route("guild")
        route("id") 
            get  ... 
        
     

好吧，如果可能的话，我该怎么做？我应该输入哪种类型的信息？如何在其他方面实现 Ktor 兼容性？ （我有另一个自己做的路由器用于其他用途）

【参考方案1】：

Dokka 不支持 Ktor 路由，而且我不知道有任何添加此类支持的计划，因此无法在生成的文档中包含有关路由的信息。