このドキュメントでは、プロジェクトに対してコードを提出するために必要とされる
コーディングの取り決めのリストについて説明しています。
デフォルトで、あなたが取り組んでいるコードにおいて、たいていのオープンソース・プロジェクトのコーディング規約は、現存のコーディング規約に従うべきです。
例えば、if 文と同じ行に括弧がある場合には、
あなたは全てその規約にしたがってあなたのコードを書くべきです。
もしあなたの commit コードが、以下の制約にしたがっていない場合には、
あなたは自身のコードを修正する責任があります。
以下は、Turbuine に特有のコーディング規約のリストで、その他は特に言及しないかぎり
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 です：
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>
|
|
|
|
|
ご協力感謝します。
