SuperAPI AI 工具集

coding-guidelines

编程与开发

查看项目

更新于 10-15 22:09

技能介绍

用途:这是一套面向编码任务的行为准则,用于减少 LLM 在编写、修改或评审代码时的常见错误;适用于实现任务、代码变更、重构等场景。

主要能力与要点:

  1. 编码前先思考:不要臆测,不要隐藏困惑,要暴露权衡。实现前明确陈述假设,不确定就问;存在多种解释时列出而非默默选择;有更简单方案要说明,必要时提出反对;不清楚就停下并指出困惑点,诚实表达不同意见。
  2. 简单优先:用解决问题的最少代码,不做推测性设计。不添加未被要求的功能,不为一次性代码做抽象,不引入未要求的灵活性和可配置性,不为不可能发生的场景写错误处理。若 200 行可缩到 50 行就重写;自问资深工程师是否会认为过度复杂。
  3. 外科手术式修改:只碰必须碰的地方,只清理自己造成的混乱。编辑既有代码时,不要顺手“改进”相邻代码、注释或格式,不重构没坏的东西,匹配既有风格;发现无关死代码只提及不删除。若改动产生孤立代码,删除由本次改动导致未使用的导入、变量或函数,不删除原本就存在的死代码。判断标准:每一行改动都应能直接追溯到用户请求。
  4. 目标驱动执行:定义成功标准并循环直到验证通过。把任务转化为可验证目标,如“加校验”转为先为非法输入写测试再让测试通过;“修 bug”转为先写复现测试再让其通过;“重构 X”转为确保重构前后测试通过。多步任务给出简短计划,每步写明验证点。强成功标准可独立循环,弱标准则需不断澄清。

使用方式:作为编码任务中的行为约束,在写、改、审代码时遵循上述原则。对琐碎任务可自行判断是否简化流程。

限制:资料未提供关于安装命令、平台支持、价格或具体工具集成的信息。