このドキュメントでは、プロジェクトに対してコードを提出するのに必要な、 コーディング規約のリストについて説明しています。 たいていのオープンソースプロジェクトのコーディング規約は、 デフォルトでは、あなたが取り組んでいるコードにある、 既存のコーディング規約に従うべきです。 例えば、if 文と同じ行に括弧がある場合には、 あなたは全てその規約にしたがってあなたのコードを書くべきです。

もし、これらの制約にしたがっていないコードをコミットしたら、 責任をもって自分のコードを修正しなければなりません。

以下は、Velocity 固有のコーディング規約のリストで、その他は特に言及しないかぎり Sun Java コーディング規約に従います。

1. 括弧の開始・終了は新しい行で行います。
例:

2. 括弧の間にスペースをいれるのは OK です。 ただし、スペースが入れない方が望ましいです。 例えば、これらは両方とも、OK です：

3. (インデントは)4つのスペースで。タブはダメです。以上。 多くの人がタブを使いたがるのは理解していますが、実際問題として、 分散開発環境では、タブを使用していると、 cvs コミットメッセージがメーリングリストに送られた時に、 コミットメッセージがほとんど読めません。

Emacs では、以下のコマンドで変換を行えます。
(setq-default tab-width 4 indent-tabs-mode nil)

4. .java ソースコードファイルは全て、Unix 改行コードを使用します。 その他のプラットフォーム固有のファイルでは、 プラットフォーム固有の改行を使用します。

5. すべてのメソッドにjavadocがなければなりません。 また、既存のコードで作業をしていて、javadoc が無いようなメソッド/クラス/変数などを見つけたら追加してください。 こうしたことで、プロジェクトが全体として改善されます。

6. Apache Software License は、 すべてのファイルの先頭に挿入しなければなりません。

7. ファイル(コードやドキュメント)に貢献していただいたら、 自分の名前をファイルの先頭に追加してください。 java ファイルでは、望ましいJavadoc 形式は以下の通りです。

ご協力をお願いします。

コーディングを簡単にするために、以下のちょっとした Emacs LISP で、 括弧づけについて、「正しく」行うことができます。

注意: これは、emacs ですべての java に適用されます。 制御するためには、以下のようにします。

• オフ : M-: (remove-hook 'java-mode 'apache-jakarta-mode)
• オン : M-: (add-hook 'java-mode 'apache-jakarta-mode)

ここの内容はすべて、Daniel L.Rall が Turbine プロジェクトに貢献してくれたものを使わせてもらいました。 ありがとうダニエル！