Velocity

Velocityについて

コミュニティ

ドキュメント

比較

ツール

日本語訳について

コーディング標準

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

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

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

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


if ( foo )
{
    // code here
}

try
{
    // code here
}
catch (Exception bar)
{
    // code here
}
finally
{
    // code here
}

while ( true )
{
    // code here
}

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


if (foo)

or

if ( foo )

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 形式は以下の通りです。

@author <a href="mailto:user@domain.com">John Doe</a>

ご協力をお願いします。


Emacsの便利ツール

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

(defun apache-jakarta-mode ()
  "Apache Jakartaプロジェクト向けJavaモード特殊化"
  (if (not (assoc "apache-jakarta" c-style-alist))
      ;; Apache Jakarta cc-mode スタイルを定義。
      (c-add-style "apache-jakarta" '("java" (indent-tabs-mode . nil))))

  (c-set-style "apache-jakarta")
  (c-set-offset 'substatement-open 0 nil)
  (setq mode-name "Apache Jakarta")

  ;; Xウィンドウだったら、シンタックスハイライトをONにする。
  (if (boundp 'window-system)
      (progn (setq font-lock-support-mode 'lazy-lock-mode)
             (font-lock-mode t))))

;; Jakartaモードを有効にする。
(if (fboundp 'jde-mode)
    (add-hook 'jde-mode-hook 'apache-jakarta-mode)
  (add-hook 'java-mode-hook 'apache-jakarta-mode))

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

  • オフ : M-: (remove-hook 'java-mode 'apache-jakarta-mode)
  • オン : M-: (add-hook 'java-mode 'apache-jakarta-mode)
もちろん 'M-:' はメタキーを押しながら':'を押すことを示します。 スタートアップ時のデフォルトは ON です。

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



このドキュメントは、 熊坂祐二 が訳しました。
コメントがある場合は、 report@jajakarta.org までお願いします。
オリジナル英文 Copyright © 1999-2003, The Apache Software Foundation