SuperAPI AI 工具集

common-best-practices

编程与开发

查看项目

更新于 10-15 22:13

技能介绍

用途:作为跨语言的全局编码最佳实践(优先级 P0),在重构时约束代码结构与可读性。

主要能力:遵循 SOLID(单一职责、开闭、里氏替换、接口隔离、依赖倒置);强调 KISS/DRY/YAGNI,优先可读性,抽象重复逻辑,避免“以防万一”式代码;命名须表达意图(如 isUserAuthenticated 优于 checkUser),并匹配语言的大小写风格。代码卫生方面:函数少于 30 行、服务少于 600 行、工具类少于 400 行;使用卫语句提前返回,避免深层嵌套;注释解释“为什么”而非“做什么”,应重构坏代码而非注释它;校验并清理所有外部输入。

反模式:禁止硬编码常量,改用命名的配置或环境变量;禁止深层嵌套,改用卫语句;禁止全局状态,优先依赖注入;禁止空 catch,必须处理、记录或重新抛出。

使用方式与适用场景:用于代码审查与重构,统一多语言项目的结构与命名规范。资料还提及 Code Structure Patterns 与 Effectiveness Guide 两个参考主题,但未给出具体内容与命令。

限制:资料未说明具体安装命令、支持的平台与集成方式,亦未提供收费、价格或效果数据,这些暂未提供。