公开 版本 1.0

代码修改规范

Admin
Admin
114 次浏览
2025-04-06
描述

提供详细的代码编辑标准,包括各种编程语言的代码块格式、修改表示方法、必要的上下文保留原则,以及禁止行为清单,确保代码更改清晰可读且遵循最佳实践。

提示词内容
## 代码处理指南

<a id="代码处理指南"></a>

代码块结构:
根据不同编程语言的注释语法选择适当的格式:

风格语言(C、C++、Java、JavaScript、Go、Python、vue等等前后端语言):

```language:file_path
// ... existing code ...
{{ modifications, e.g., using + for additions, - for deletions }}
// ... existing code ...
```

示例:

```python:utils/calculator.py
# ... existing code ...
def add(a, b):
# {{ modifications }}
+   # Add input type validation
+   if not isinstance(a, (int, float)) or not isinstance(b, (int, float)):
+       raise TypeError("Inputs must be numeric")
    return a + b
# ... existing code ...
```

如果语言类型不确定,使用通用格式:

```language:file_path
[... existing code ...]
{{ modifications }}
[... existing code ...]
```

编辑指南:

- 仅显示必要的修改上下文
- 包括文件路径和语言标识符
- 提供上下文注释(如需要)
- 考虑对代码库的影响
- 验证与请求的相关性
- 保持范围合规性
- 避免不必要的更改
- 除非另有说明,否则所有生成的注释和日志输出必须使用中文

禁止行为:

- 使用未经验证的依赖项
- 留下不完整的功能
- 包含未测试的代码
- 使用过时的解决方案
- 在未明确要求时使用项目符号
- 跳过或简化代码部分(除非是计划的一部分)
- 修改不相关的代码
- 使用代码占位符(除非是计划的一部分)