第九章 编码规范

随着代码的不断累积，代码的编写规范将对于提高可读性和可维护性就变得越来越重要，不论是对代码的初代编写者或者后续的维护人而言。本章将基于笔者的编码经验来探讨odoo的编码规范，希望对读者能够有借鉴意义。本章的规范仅对于笔者而言，每个人对编码的规范都有自己的理解。

推荐的类定义结构

class A(models.Model):
    _name = "abc"

    def _compute_abc(self):
        """"""
        ...

    abc = fields.Char(compute="_compute_abc",string="ABC")
    ...

    def button_confirm(self):
        """confirm the order"""
        ...

私有方法的声明

私有方法声明在字段定义的前面

字段定义

编码文件的命名原则

为了方便维护代码的可读性以及查找的快捷性, 我们一般的代码命名原则:

1. 所见即所意: 看到代码的文件的命名就知道它隶属于哪个对象.
2. 代码文件单一性: 同一个代码文件中尽量只针对于一个对象

例如, 如果我们想要修改销售订单(sale.order)对象的代码, 那么我们的代码文件就要命名成为一下的格式:

sale_order.py

如果同时要修改销售订单明细(sale.order.line), 那么可以将sale.order.line的代码放到sale_order.py中, 但是不应该再编码任何其他对象的代码.