From f01eb56097d4c9724611958bce7e6b237fe8095e Mon Sep 17 00:00:00 2001 From: cheney Date: Tue, 21 Jul 2026 14:24:13 +0800 Subject: [PATCH] save --- kit/doc/开发规范.md | 39 ++++++++++++++++++++++++++++++++++++--- 1 file changed, 36 insertions(+), 3 deletions(-) diff --git a/kit/doc/开发规范.md b/kit/doc/开发规范.md index feac4bf..b238da1 100644 --- a/kit/doc/开发规范.md +++ b/kit/doc/开发规范.md @@ -1,3 +1,36 @@ -- 每个函数都要有中文注释, 包括功能说明、参数说明、返回值说明等,如果有注意事项,也要在注释中特别说明。 -- 每次需求修改都要同时更新文档、代码、测试代码。 -- 每条测试用例都要有一个唯一编号。例如 1-1、2-20 等。 \ No newline at end of file +- ## 编码前思考 + - 明确假设,不确定时询问而非猜测。 + - 存在歧义时,列出多种解释,不默默选定单一方案。 + - 如果任务有明显更简单的做法,直接指出优化思路。 + - 发现代码矛盾、逻辑不一致时及时暂停,请求信息澄清。 + + ## 简洁优先 + + - 用最少的代码解决问题,拒绝冗余实现。 + - 不为一次性需求创建抽象层、复杂架构。 + - 不盲目增加扩展性、可配置性,应对“未来可能用到”的场景。 + - 若代码可大幅精简,主动重写优化。 + - 校验标准:以资深工程师视角判断,代码若过于复杂,立即简化。 + + ## 精准修改 + + - 仅修改与当前任务直接相关的代码内容。 + - 不顺手优化相邻代码、注释、排版格式。 + - 不重构原本可以正常运行的代码模块。 + - 严格匹配项目现有代码风格,保留原有编码习惯。 + - 因本次修改产生的无效导入、废弃变量,可直接删除。 + - 发现项目中原有的死代码、冗余内容,仅做文字提醒,不擅自删除。 + + ## 目标驱动执行 + + - 执行任务前,定义清晰、可落地的成功标准。 + - 将“修复Bug”转化为:编写用例复现问题,再调试至用例正常通过。 + - 将“新增校验功能”转化为:针对异常输入编写测试用例,保证全部通过。 + - 将“代码重构”转化为:完成重构后,确保原有所有测试用例正常运行。 + - 多步骤复杂任务,先输出简短执行计划,同时标注每一步的验证方式。 + + ## 编程规范 + + - 每个函数都要有中文注释, 包括功能说明、参数说明、返回值说明等,如果有注意事项,也要在注释中特别说明。 + - 每次需求修改都要同时更新文档、代码、测试代码。 + - 每条测试用例都要有一个唯一编号。例如 1-1、2-20 等。 \ No newline at end of file