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(...)