自用代码风格审查技能分享

在编程领域，代码风格审查是一个至关重要的环节，它有助于确保代码的质量和可维护性。以下是一个自用的代码风格审查技能（code-style-review），它基于Python编程语言，旨在帮助开发者编写和审查Python代码时遵循一套统一的风格指南。

核心原则

1. 命名规范：类名使用PascalCase（如DataLoader），函数和方法名使用snake_case（如load_data），常量使用UPPER_CASE（如MAX_RETRIES），数学运算允许使用单字母变量（如N, D, x, y）。
2. 异常处理：采用快速失败原则，避免使用防御性编程，让错误尽早崩溃。对于可恢复的问题，使用logger.warning()而不是异常。
3. 代码哲学：避免过度设计，保持简单；仅使用英文注释；遵循奥卡姆剃刀原则，避免不必要的复杂性。

推荐做法

• 注释和文档：仅对复杂逻辑提供最小化文档字符串，解释“为什么”而不是“什么”；自解释性代码无需注释。
• 导入：按照stdlib → third-party → local的顺序导入，并在之间添加空行；优先使用绝对导入；避免使用import *。
• 函数设计：明确参数；避免使用**kwargs；使用元组进行多返回值；避免隐藏的全局状态。
• 代码组织：采用分层架构，从低级到高级；对核心逻辑使用面向对象编程；实现关注点分离。
• 美学：保持代码对齐和简单命名；为用户体验提供彩色输出/进度条；使用logging模块。

可选做法

• 类型注解：使用Python 3.10+语法，如list[int], X | None；注解公共方法和返回类型。
• 断言：谨慎使用断言来检查不变量，不要过度使用。
• 日志记录：根据用户请求选择性地将日志写入文件。

加分项

• 数据结构：使用@dataclass进行配置；优先使用简单的容器（如list, dict）。

代码审查

所有代码审查工作委托给Codex处理。Claude不应直接运行脚本。调用时，Claude必须将占位符替换为绝对路径。审查结果应包括自动化问题列表、需要人工判断的问题、具体改进建议以及代码示例。

以上是一个详尽的代码风格审查技能，旨在帮助开发者编写出更高质量、更易于维护的代码。开发者可以根据自己的需求进行二次开发，并反馈改进建议，以不断完善这一技能。