SuperAPI AI 工具集

android-kotlin-api-design-reviewer

编程与开发

查看项目

更新于 10-15 21:08

技能介绍

用途:审查 Kotlin 函数与类接口是否符合 Kotlin Coding Conventions,适合在创建公开 API、可复用组件、库接口时使用。

主要能力:覆盖命名规则(属性、函数、变量用 lowerCamelCase;类、接口、对象用 UpperCamelCase;常量用 UPPER_SNAKE_CASE;布尔值用 is、has、can、should 前缀;集合用复数名如 users 而非 userList);Compose 命名(返回 Unit 的可组合函数用 PascalCase 名词,如 UserProfileCard,避免空格与反引号标识符);函数设计(首个参数之后使用具名参数、默认参数置于末尾、异步用 suspend、工具方法用扩展函数、语义合适时用运算符重载、廉价且不抛异常时优先属性而非无参函数、公开 API 多参数调用用具名参数与尾随逗号);返回类型(null 有意义时用可空、可失败操作用 Result、流用 Flow、有限状态用 sealed class、公开库 API 显式声明返回类型);数据类(用于 DTO、默认不可变 val、用 copy 更新、支持解构);公开 API/库(所有公开成员提供 KDoc、用 @JvmName 改善互操作命名、用后备属性 _internalValue 观察状态、重复复杂函数类型考虑类型别名)。

常见问题与修复:var visible 改为 var isVisible;fun getData() 改为 fun getUserName();var nameString 改为 var name;userList 改为 users;可组合函数命名像普通函数则改为 PascalCase 名词(ProfileScreen);库中隐式返回类型则添加显式 : String。

严重级别:🔴 Critical 违反规范;🟡 Improvement 可更清晰;🟢 Enhancement 可选润色。

限制:资料未提供安装命令、平台支持、收费方式与具体使用步骤。