87 lines
1.5 KiB
Plaintext
87 lines
1.5 KiB
Plaintext
# 代码修改最佳实践
|
|
|
|
1. 修改前的准备
|
|
|
|
- 检查相关文件和依赖关系
|
|
- 确保命名一致性
|
|
- 添加必要的日志记录
|
|
- 准备回滚方案
|
|
|
|
2. 修改过程中
|
|
|
|
- 遵循统一的代码风格
|
|
- 添加适当的错误处理
|
|
- 保持代码的可读性
|
|
- 避免重复代码
|
|
|
|
3. 修改后的验证
|
|
|
|
- 验证主要功能
|
|
- 测试边界条件
|
|
- 检查错误处理
|
|
- 验证性能影响
|
|
|
|
4. 文档更新
|
|
|
|
- 更新相关文档
|
|
- 添加注释说明
|
|
- 记录重要修改
|
|
- 更新调试信息
|
|
|
|
5. 代码审查要点
|
|
|
|
- 检查命名规范
|
|
- 验证错误处理
|
|
- 确认日志完整性
|
|
- 评估代码质量
|
|
|
|
6. 调试建议
|
|
|
|
- 添加详细日志
|
|
- 使用断点调试
|
|
- 验证数据流
|
|
- 检查状态变化
|
|
|
|
7. 性能考虑
|
|
|
|
- 避免过早优化
|
|
- 关注关键路径
|
|
- 合理使用缓存
|
|
- 优化数据库查询
|
|
|
|
8. 安全性检查
|
|
|
|
- 验证输入数据
|
|
- 处理异常情况
|
|
- 保护敏感信息
|
|
- 添加访问控制
|
|
|
|
9. 中文处理规则
|
|
|
|
- 不修改任何包含中文的注释行
|
|
- 使用 `// ... existing code ...` 跳过包含中文的代码块
|
|
- 如需修改中文附近的代码，应完整保留原有中文内容
|
|
|
|
示例：
|
|
```
|
|
// ... existing code ...
|
|
// 这是中文注释，保持不变
|
|
newCode = value;
|
|
// ... existing code ...
|
|
```
|
|
|
|
10. 编码规则
|
|
|
|
- 所有文件统一使用 UTF-8 编码
|
|
- 不使用 BOM 头
|
|
- 换行符统一使用 LF (\n)
|
|
- 文件末尾保留一个换行符
|
|
- 代码注释中的中文必须使用 UTF-8 编码
|
|
|
|
配置示例：
|
|
```json
|
|
{
|
|
"charset": "utf-8",
|
|
"end_of_line": "lf",
|
|
"insert_final_newline": true
|
|
} |