SuperAPI AI 工具集

code-style

编程与开发

查看项目

更新于 10-15 20:10

技能介绍

用途:这是一套语言无关的代码设计规则,用于在实现、重构或评审代码时,让代码对状态、失败、所有权与副作用保持显式与诚实。

主要能力与要点:

控制流表达:让允许状态与成功路径易于阅读;条件需否定才能理解时改用肯定表达;用守卫子句提前拒绝无效或异常情况;在生效点让决策可见,不用隐式行为隐藏有效值或控制流;条件表达式仅用于在两个简单值间选择,不用于隐藏副作用。

状态显式化:让有效状态显式并在全系统强制;通过不变量让矛盾字段组合不可表示;内部保证被破坏时让不可能状态失败,而不是继续使用臆造状态;防止新的有限状态成员在穷尽决策中静默继承兜底分支。

边界与资源:在边界处处理并记录每个失败一次,保留无关错误及其原始原因;把资源所有权绑定到生命周期,使资源不会被未初始化或未释放地逸出;归一化外部数据时保留调用者相关信息,把继续、重试、过滤、回退等策略留给调用者;通过惰性分页让消费者控制继续与停止。

抽象与契约:避免一次性或装饰性间接层,保持抽象简单;在第一个受控边界把不可信外部载荷转换为可信值;必需的缺失应显式表达,除非领域定义了确切值,否则拒绝臆造默认值;公共表面保持有意且无副作用、范围窄;把决策放在纯核心,把 I/O 放在命令式外壳。

使用方式:将每条指令视为语言无关的语义要求;资料中的 TypeScript 示例需适配目标语言的原生语法、类型系统、资源管理机制与编译器检查。编写或评审代码前,先阅读适用的链接参考。

适用场景:代码实现、重构、代码评审。

限制:暂未提供具体安装方式、命令、平台与价格信息。