コーディング標準

CouchDB は、さまざまな言語で記述されたコードから構成されています。中核になる部分は Erlang で書かれていますが、C で書かれている部分もあれば、HTML、CSS、JavaScript で書かれている部分もあり、シェルスクリプトや Makefile などで書かれている部分もあります。

まずは一般的な規則から。

  • Makefile を除いて、インデントにはタブではなく常にスペースを使ってください。
  • Erlang コードと C コードではインデントに 4 つのスペースを使用し、HTML、CSS、および JavaScript では 2 つのスペースを使ってください。
  • 1 行はなるべく 80 文字以内に収めてください。
  • ファイルを編集するときは、できるだけ前後のコードで使われているコーディング規約に従ってください。
  • ファイルの末尾や行末に余計なスペースや改行が残らないようにしてください。通常、優れたエディタには、こうしたスペースや改行を残さないようにするための設定オプションが用意されているはずです。
  • 純粋に表面的な変更(末尾のスペースの削除など)と、機能上の変更とを混在させないようにしてください。この種の変更の混在は、(チェックインであれパッチであれ)実際の変更内容のレビューを非常に困難なものにします。

Erlang コードのコーディング規約の詳細については、Erlang Programming Rules and Conventions を参照してください。