この文書で略述されているコード化一般規則に従って、本プロジェクトへの参加をお願いします。
一般的に、多くのオープンソースのプロジェクトでは、コード化をする際は既存のコードの中のコード化の規則に従うべきとされています。
例えば、もし既にあるコード内で if 文が同一行内で括弧で括られていれば、其の後書き換えるコードも同じ規則に従ってください。
この文書の以下に略述されたコード化一般規則に従わない開発者の方は、自己責任でそのコードを直さなければならなくなります。
この文書に明示されていない事柄については、あくまで、公式の Sun Java Coding Conventionsに従うようにして下さい。
1. 中括弧（ブラケット）の初め"{"と終わり"}"は、例え１行の文であったとしても、行を新たにして書いて下さい。例えば：
 | | |
|
if ( foo )
{
// code here
}
try
{
// code here
}
catch (Exception bar)
{
// code here
}
finally
{
// code here
}
while ( true )
{
// code here
}
| |
| | |
2. 括弧() の間に空白（スペース）を入れるか否かは任意です。どちらかといえば、余計な空白は無い方が良いですが、どちらでも大丈夫です：
3. 4つのスペース／タブ使用禁止／修辞子の挿入をお願いします。
多くの開発者がタブを使いたがる事は知っていますが、実際の問題は、皆それぞれ離れた開発環境下にあるため、diff形式のパッチがメーリングリストやCVS（Version Control System：コミットログメッセージを流す）に送られた場合、タグを使っていると、読みやすさを保てなくなってしまうのです。
Emacs環境で言えば、tabを変換するには以下のコマンドを使います：
| | |
|
(setq-default tab-width 4 indent-tabs-mode nil)
| |
| | |
4. Unixラインフィード(LF)を全ての.java形式ソースコードファイルに使用してください。プラットフォーム依存のファイル（例えば、Windows上でしか動かない.batファイル）は、non-Unixのラインフィードであるべきでしょう。
5. Javadocが全てのメソッドに存在しなければなりません。メソッド／クラス／変数用のJavadocが記述されていない提供も、本プロジェクトの発展の為、大いに歓迎します。
6. [ Jakarta Apache/OJB License] が全てのファイルのトップに書かれていなければなりません。
7.
もし貴方がファイル（ソースコードやドキュメント）に投稿して、自分自身を
ファイルの先頭の筆者（author）リストに追加してください。.javaファイルは
以下のJavadoc形式である方が良いでしょう：
| | |
|
@author <a href="mailto:user@domain.com">John Doe</a>
| |
| | |
8. .javaファイルには、全て、以下のように @version タグをつけてください：
| | |
|
@version $Id: code-standards.xml,v 1.1.1.1 2002/06/17 18:16:59 jvanzyl Exp $
| |
| | |
9. Import文は完全に明確に書いてください（訳注：* を使ったりしないように）。
| | |
|
import java.util.ArrayList;
import java.util.Hashtable;
import org.apache.foo.Bar;
import org.apache.bar.Foo;
| |
| | |
そして、くれぐれも以下のようにはしないで下さい：
| | |
|
import java.util.*;
import org.apache.foo.*;
import org.apache.bar.*;
| |
| | |
X/Emacsユーザは、.emacsファイルでこうなっていると良かろうかと思います。
| | |
|
(defun apache-jakarta-mode ()
"The Java mode specialization for Apache Jakarta projects."
(if (not (assoc "apache-jakarta" c-style-alist))
;; Define the Apache Jakarta cc-mode style.
(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")
;; Turn on syntax highlighting when X is running.
(if (boundp 'window-system)
(progn (setq font-lock-support-mode 'lazy-lock-mode)
(font-lock-mode t))))
;; Activate Jakarta mode.
(if (fboundp 'jde-mode)
(add-hook 'jde-mode-hook 'apache-jakarta-mode)
(add-hook 'java-mode-hook 'apache-jakarta-mode))
| |
| | |
ご協力有難う御座います。
