SuperAPI AI 工具集

kdoc

编程与开发

查看项目

更新于 10-16 09:34

技能介绍

用途:为 Kotlin 公共声明补充或重写 KDoc 文档,适用于用户要求记录 Kotlin 代码、添加 KDoc、生成 API 文档,或指出存在未文档化的公共 API 时。

主要能力:覆盖类、接口、对象、函数、属性、枚举、类型别名、注解,包括 @Deprecated 声明;要求阅读实现而非仅看签名,以写出准确描述;对不完整或质量较低的既有 KDoc 进行重写。

标签放置规则:主构造函数的 public/internal/protected val 或 var 使用类 KDoc 中的 @property;主构造函数中无 val/var 的参数使用类 KDoc 中的 @param;主构造函数中的 private val/var 使用类 KDoc 中的 @param;类、对象、接口、密封接口体内的声明使用其上方内联的 /** */;函数参数使用 @param;非 Unit 返回类型使用 @return。

风格要求:摘要为一句简洁的第三人称动词句(如 Creates、Returns、Represents),仅在确实复杂时扩展为 2 至 3 句;DSL 构建器必须提供示例块并展示完整接收者作用域用法,复杂函数或不易理解的扩展函数可添加示例,单行函数与简单 getter 跳过;仅在具有导航价值处使用 KDoc 链接(如 [ClassName]、[methodName]);不写 @throws 或 suspend 说明。

限制:资料未提供安装方式、运行命令、平台支持、收费与价格信息,暂未提供。