common-cn

全局代码规范

1. 基本原则

• 优先选择简单方案
  • 避免过度设计，用最直接的方式实现需求。
• 严格避免代码重复
  • 修改前检查代码库是否已存在相似逻辑，复用现有实现。

2. 环境管理

• 明确区分环境
  • 开发环境（dev）、测试环境（test）、生产环境（prod）必须隔离，禁止混用配置。
• 禁用模拟数据滥用
  • 仅测试环境允许使用 Mock 数据，开发和生产环境严禁使用。

3. 代码修改准则

• 谨慎修改
  • 仅针对明确需求更改，确保理解修改的影响范围。专注任务相关的代码区域。不触碰与任务无关的代码。
  • 为所有主要功能编写全面测试。
  • 在功能运行良好后，避免对其模式和架构进行重大更改（除非明确要求）
  • 始终考虑代码变更可能影的的其他方法和代码区域
• 避免引入新技术
  • 优先排查现有方案，若必须引入新逻辑，需同步清理旧代码。

4. 代码整洁性

• 禁止临时脚本驻留
  • 一次性脚本（如数据迁移）执行后需立即删除，禁止留存于代码库。
• 控制文件体积
  • 单文件代码超过 200~300 行时需重构拆分。

编码风格 (Coding styles) .1 General rules • Follow the user's requirements carefully & to the letter. • Always write correct, up-to-date, bug-free, fully functional and working, secure, performant and efficient code. • Focus on readability over being performant. • Fully implement all requested functionality. • Leave NO todo's, placeholders or missing pieces in the code. • Be sure to reference file names. • Be concise. Minimize any other prose. • If you think there might not be a correct answer, you say so. If you do not know the answer, say so instead of guessing. • Don't forget to update codebase documentation with changes. • Always add a blank line at the end of the file • Use UTF-8 encoding 1.2 Naming Conventions • Variable name: camel_case • Class name: PascalCase • Constant: UPPER_SNAKE_CASE • File name: kebab-case • Function name: camelCase 1.3 Commenting conventions 注释要面向小白，explain the "what"+"why" of the code, 不必担心注释过长。 2. Documentation 2.1 README Essentials • 项目概述 • 文件架构和每个文件的功能 • 怎么使用这个项目 • 文件的创建/调试顺序 • Environment Setup 2.2 通过ipynb文件解释代码：[逻辑块拆分代码+代码超详细的解释]。 案例：

2. 配置日志

logging.basicConfig(level=logging.INFO, format='%(asctime)s - %(name)s - %(levelname)s - %(message)s') logger = logging.getLogger(name)

这段代码配置了日志输出：

• logging.basicConfig：配置日志的基本设置
  • level=logging.INFO：设置日志级别为INFO，只记录INFO级别及以上的日志
  • format='...'：设置日志格式，包括时间、名称、级别和消息
• logger = logging.getLogger(__name__)：创建一个与当前模块同名的日志记录器 这样设置后，程序会在控制台输出格式化的日志信息，帮助开发者追踪程序的执行过程。