约定事项

指南

关于 OpenERP 模块的开发指南和一般建议， 请参阅 贡献 文件里的 指南

模块结构和文件名称

模块的结构应该如下:

  1. /module/
  3.     /__init__.py
  4.     /__openerp__.py
  5.     /module.py
  6.     /module_other.py
  7.     /module_view.xml
  8.     /module_data.xml
  9.     /module_demo.xml
  11.     /wizard/
  12.     /wizard/__init__.py
  13.     /wizard/wizard_name.py
  15.     /report/
  16.     /report/
  17.     /report/__init__.py
  18.     /report/report_name.sxw
  19.     /report/report_name.rml
  20.     /report/report_name.py

Naming conventions

  • 模块: 模块名称应该使用下划线(_)，加上小写字母。模块的名称就是服务器上插件所在的路径名称。如果某个模块依赖其他的模块，你可以用最重要的模块作为名称的开始，把其他几个模块的名称用下划线分别串起来。例如:

    • sale

    • sale_commission

  • 物件: 物件的名称必须依照以下的形式 模块名称.物件名称1.物件名称2.物件名称3…. 物件名称i 的排列顺序必须是由最重要的到最不重要的，由左到右，而且要是小写字母。尽量不要在物件名称里使用复数形式，同时要避免在名称里使用捷径。例如:

    • sale.order

    • sale.order.line

    • sale.shop

    • sale_commission.commission.rate

  • 字段: 字段必须是小写，加上分隔的下划线。尽量使用一般常用的字段名称，例如：name, state, active, partner_id, 等等。字段名称是依据字段的属性来约定的:

    • 多对一: 必须在结尾加上 ‘_id’ (例如: partner_id, order_line_id)

    • 多对多: 必须在结尾加上’_ids’ (例如: category_ids)

    • 一对多: 必须在结尾加上’_ids’ (例如: line_ids)