SuperAPI AI 工具集

coding-principles

编程与开发

查看项目

更新于 10-16 01:14

技能介绍

用途:这是一套与语言无关的编码原则,供实现功能、重构代码或评审代码质量时参考,目标是长期可维护性、可读性与质量,而非初期开发速度。

主要能力:核心哲学强调可维护性优先、简单优先(YAGNI)、显式优于隐式、删除而非注释掉无用代码。代码质量方面要求增量改进、使用领域内有意义的完整命名、把魔法数字与字符串提取为常量、保持代码自解释。函数设计上要求单一职责、单一抽象层级、尽量使用纯函数、分离数据转换与副作用、用提前返回减少嵌套。错误处理要求始终处理错误、记录上下文、屏蔽敏感数据、快速失败并传播有意义的错误信息。依赖管理主张通过参数注入依赖、依赖抽象而非具体实现、降低模块间耦合。性能上要求先测量再优化,关注算法复杂度与合适的数据结构。注释原则是代码优先,注释只用于解释原因、限制/边界情况或公共 API 契约,历史上下文写入版本控制提交信息。重构要求小步进行、保持测试通过、每次改动后验证行为。安全方面要求凭据通过环境变量或密钥管理器存储、使用参数化查询、使用成熟加密库、用密码学安全随机数生成安全关键值、在系统入口校验外部输入、按渲染上下文编码输出、对每个资源访问做授权校验并遵循最小权限。

使用方式:资料未提供具体安装命令或调用方式,仅说明安全审查的具体检测模式见 references/security-checks.md。

适用场景:功能实现、代码重构、代码质量评审,以及需要统一团队编码约定的项目。

限制:资料未提供收费、价格、平台支持范围等信息;原则为通用指导,具体落地需结合所用语言与项目约定。