コーディングポリシー - loveapple Wiki - loveapple

Outline

1. loveappleプロジェクトのコーディングポリシー
   1. CVSリポジトリーにてソースコードの管理について
      1. リポジトリーのモジュールについて
   2. 常識と思われること
   3. アノテーション
   4. 簡潔にソースコードの処理を説明するコメントをJavadocに対応すべき
      1. 空のパッケージ用Javadocテンプレート
      2. ソースコードの冒頭に埋め込むライセンス情報

loveappleプロジェクトのコーディングポリシー

CVSリポジトリーにてソースコードの管理について

リポジトリーのモジュールについて

ソースコードのチェックアウトについてソースコード管理を参照すること

1. doc　　　　　⇒　プロジェクト文書を管理する
2. loveapple　⇒　loveapple基底API
3. client　　⇒　loveappleクライアントライブラリ。CUI/GUI操作APIを含む
   1. アプリケーションはマルチスレッドで動作し、クライアント側、スレッド操作モジュールも含む
4. server　　　⇒　loveappleサーバライブラリ。ただし、クライアント完成した後開始する予定
   1. サーバ側、PHP又はJavaで開発する予定だが、現時点実装方法未定
5. deploy　　　⇒　リリース用モジュール

常識と思われること

• Java(TM)言語コーディング規約(英語版)をもとにJavaのコーディングを行うこと

アノテーション

• DataField
  DBテーブルと対応するPOJOフィールド
• ReadyPlugin
  プラグインから挿入により処理を追加できるクラス又はメソッド
• SetSystemConfig
  クラスの前につける。
  • オブジェクトの初期化を行うタイミングでAspectJから該当するアノテーションが呼び出されるクラスにSystemConfigビーンのフィールドにインスタンスをセット

簡潔にソースコードの処理を説明するコメントをJavadocに対応すべき

空のパッケージ用Javadocテンプレート

• javadoc - Java API ドキュメントジェネレータ
• TODOeclipseにてpackage-info.javaを利用するための対策
  
  • 現状はpackage.htmlを私用してるので、現状のまま
  • package-info.javaの代替PackageInfo.javaをコーディング時に作成して、antでjavadocを作成する際に、PackageInfo.javaをpackage-info.javaに変換してjavadoc作成処理を行い、処理後、package-info.javaをPackageInfo.javaに戻す

ソースコードの冒頭に埋め込むライセンス情報

Java

 /*
  * $HeadURL$
  * $Author$
  * $Revision$
  * $Date$
  *
  * ====================================================================
  *
  * Copyright (C) 2008 by loveapple.sourceforge.jp
  *
  * All copyright notices regarding loveapple and loveapple CoreLib
  * MUST remain intact in the scripts, documents and source code.
  *
  * This library is free software; you can redistribute it and/or
  * modify it under the terms of the GNU Lesser General Public 
  * License as published by the Free Software Foundation; either
  * version 3 of the License, or (at your option) any later version.
  *
  * This library is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  * Lesser General Public License for more details.
  *
  * You should have received a copy of the GNU Lesser General Public
  * License along with this library; if not, write to the Free Software
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
  *
  * Correspondence and Marketing Questions can be sent to:
  * info at loveapple
  *
  * @author: loveapple
  */

SQL

 -- ==================================================================================
 -- $HeadURL$
 -- $Author$
 -- $Revision$
 -- $Date$
 --
 -- ==================================================================================
 --
 -- Copyright (C) 2008 by loveapple.sourceforge.jp
 --
 -- All copyright notices regarding loveapple and loveapple CoreLib
 -- MUST remain intact in the scripts, documents and source code.
 --
 -- This library is free software; you can redistribute it and/or
 -- modify it under the terms of the GNU Lesser General Public
 -- License as published by the Free Software Foundation; either
 -- version 3 of the License, or (at your option) any later version.
 --
 -- This library is distributed in the hope that it will be useful,
 -- but WITHOUT ANY WARRANTY; without even the implied warranty of
 -- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 -- Lesser General Public License for more details.
 --
 -- You should have received a copy of the GNU Lesser General Public
 -- License along with this library; if not, write to the Free Software
 -- Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 --
 -- Correspondence and Marketing Questions can be sent to:
 -- info at loveapple
 --
 -- @author: loveapple
 --
 -- ==================================================================================

XML

 <!--
  $HeadURL$
  $Author$
  $Revision$
  $Date$
 
  ====================================================================
 
  Copyright (C) 2008 by loveapple.sourceforge.jp
 
  All copyright notices regarding loveapple and loveapple CoreLib
  MUST remain intact in the scripts, documents and source code.
 
  This library is free software; you can redistribute it and/or
  modify it under the terms of the GNU Lesser General Public
  License as published by the Free Software Foundation; either
  version 3 of the License, or (at your option) any later version.
 
  This library is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  Lesser General Public License for more details.
 
  You should have received a copy of the GNU Lesser General Public
  License along with this library; if not, write to the Free Software
  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 
  Correspondence and Marketing Questions can be sent to:
  info at loveapple
 
  @author: loveapple
 -->