odoo_coding_guidelines

Odoo 编码指南

当用户要求根据官方编码标准审查、检查、编写或验证 Odoo 代码时，使用此技能。 来源：https://www.odoo.com/documentation/19.0/contributing/development/coding_guidelines.html

根据审查内容加载相应的子文件：

• Python 文件、模型、字段、方法 → 阅读 python.md
• XML 视图、数据文件、模板 → 阅读 xml.md
• JavaScript 文件 → 阅读 javascript.md
• CSS / SCSS 文件 → 阅读 css.md
• 要求全面代码审查或检查清单 → 阅读 checklist.md
• 模块结构、文件命名、目录布局 → 阅读 structure.md

对于混合审查（例如整个模块），加载所有相关文件。

---

一般原则

语言

• 所有代码都必须使用英语：变量名、字段名、方法名、模型名、注释、提交消息、XML ID，以及用作技术标识符的字符串字面量。

注释

• 注释必须解释为什么，而不是做什么。代码本身应当足够清晰，能够说明其作用。
• 如果需要用注释解释某段代码的作用，重构代码，直到其一目了然，然后删除注释。
• 可接受的注释：隐藏的约束、不明显的不变量、针对特定错误的变通方案，以及可能令读者意外的行为。

命名

• 绝不要为了少敲几下键盘而缩写名称。自动补全让长名称不费力，而短名称会降低可读性。

  # ❌
  def comp_tot_amt(self): ...
  inv_dt = fields.Date(...)
  
  # ✅
  def _compute_total_amount(self): ...
  invoice_date = fields.Date(...)