SuperAPI AI 工具集

general-coding-guidelines

编程与开发

查看项目

更新于 10-15 22:14

技能介绍

用途:这是一套适用于所有文件类型和语言的通用编码规则,目标是维持代码质量与一致性,并预防常见错误。资料称当用户提出相关请求时应使用该技能。

主要能力(六条规则):

  1. 呈现前先验证:始终先核实信息再呈现,不要在没有明确证据的情况下做假设或推测。理由是未经验证的信息或推测会造成混乱、错误实现和时间浪费。
  2. 逐文件修改:跨多个文件提出或实施改动时,按文件逐个呈现。理由是逐个修改更易阅读 diff、便于发现错误、评审更顺畅。
  3. 避免道歉:沟通中不要使用道歉。理由是过度道歉会降低可信度并增加对话噪音,应聚焦修正问题并建设性推进。
  4. 注释中不写反馈:避免在代码注释或文档中表达自己对理解程度的反馈。理由是注释应解释代码为何如此,而非对话式反馈或任务元评论,以保持代码库整洁简洁。
  5. 避免空白改动:除非明确要求(例如运行格式化工具),不要建议或进行随意的空白改动。理由是多余空白改动会污染 diff,掩盖真正的逻辑变化。
  6. 单块编辑:对单个文件的所有编辑应放在一个块中给出,而不是对同一文件分多步说明。理由是单块完整内容更便于用户或自动化系统直接应用,无需手动拼接多个片段。

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

适用场景:适用于各类编程与代码修改任务,尤其是需要跨文件改动、代码评审、diff 可读性要求较高的场合。

限制:资料未说明支持的平台、模型、收费或价格信息,暂未提供;上述规则为通用约定,具体执行细节需以实际工具环境为准。