SuperAPI AI 工具集

odoo_coding_guidelines

编程与开发

查看项目

更新于 10-16 02:35

技能介绍

用途:当用户要求按 Odoo 官方编码标准审查、检查、编写或校验 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 以及作为技术标识符的字符串字面量。注释必须解释“为什么”而非“做什么”;若需注释说明代码块做什么,应重构代码使其自解释后删除注释。可接受的注释包括隐藏约束、非显而易见的不变量、针对特定缺陷的变通方案、会让读者意外的行为。命名不得为省按键而截断,自动补全使长名称无成本,短名称损害可读性,例如应使用 _compute_total_amount 而非 comp_tot_amt,使用 invoice_date 而非 inv_dt。

限制:资料未提供具体安装命令、收费方式、平台支持范围或实际执行效果等信息。