SuperAPI AI 工具集

code-style

设计与创作

查看项目

更新于 10-15 17:30

技能介绍

用途:在编写或修改任何代码时应用,统一命名、函数设计与代码清晰度原则。

主要能力与规则: 函数设计上,要求函数小而专注,每个函数只做好一件事;遵循单一抽象层级(SLA),函数要么调用其他方法做高层编排,要么传递数据、执行底层操作,不在同一函数体内混用抽象层级。避免 if-else,优先使用卫语句或多项式;避免标志参数,标志参数说明函数做了不止一件事,应拆分为独立函数。

命名上,用表达性命名代替注释,不使用缩写,布尔值读起来像问题(如 isEligible、isRecovering、hasPassedDeadline),集合使用复数,并善用中间变量拆分复杂条件。常量方面禁止魔法数字,应提取为具名常量。

注释方面要求少而有用:代码说明“如何”,注释说明“为什么”;若需要注释,先尝试改进命名;已知限制用 TODO: 标记;删除过时注释。

使用方式:资料未提供具体安装命令、配置方式或集成步骤,暂未提供。

适用场景:适用于任何需要编写或修改代码的工程场景,尤其适合团队统一代码风格与可读性。

限制:资料仅给出原则与示例,未说明支持的语言、工具链、平台或是否可自动检查,暂未提供。