用途:该技能用于设计、审查或改进 Swift API,使声明在使用点清晰、调用自然,并符合 Swift 命名与标签惯例。适用于代码评审、重构既有 API、以及实现新功能时先确定调用形态。
主要能力:检查声明与调用点是否清晰流畅;检查参数标签与参数命名;检查文档注释与符号标记;检查通用约定与重载安全性。改进时重命名含糊、冗余或角色不清的 API,重构标签以改善调用点语法,用基于角色的名称替换弱命名参数,解决弱类型导致的重载歧义,并强化文档摘要。
核心规则:使用点清晰优先于简洁;每个声明都应有文档注释,摘要说明其行为、返回、访问、创建或本质,并使用 Parameter、Returns、Throws、Note 等符号标记。命名上包含消除歧义所需的词,省略冗余词,按角色而非类型命名参数;工厂方法以 make 开头;无副作用 API 用名词短语,有副作用 API 用祈使动词;mutating/nonmutating 成对命名保持一致(如 sort/sorted、formUnion/union);布尔 API 读作断言(如 isEmpty、intersects)。术语优先使用常见词,使用专业术语时保留其既定含义,避免非标准缩写。
用法:先查看声明与调用点,再按需改进或从使用示例出发设计新声明;参数默认值仅在简化常见用法时添加,且默认参数靠后;参数标签依据语法和含义决定。
限制:资料未提供安装命令、平台支持、收费或价格信息;具体参考文件路径以 references/ 下的文档为准。