CodingRuleJava - UltraMonkey-L7 Wiki - UltraMonkey-L7

Java Coding Rule

---

ネーミングルール

クラス

大文字で始まる名詞をつける。内容の省略は行わないこと。アンダースコアでの連結も行わないこと。

良い例:

  class AccountManager : public ManagerBase{
    ...
  }

悪い例1: 大文字のみの単語が存在する

  class ACCOUNTManager : public ManagerBase{
    ...
  }

悪い例2: 小文字のみの単語が存在する。アンダースコアでの連結がある。

  class Account_manager : public ManagerBase{
   ...
  }

悪い例3: 単語が名詞で終わっていない

  class AccountManage : public ManagerBase{
   ...
  }

Interfaceの実装クラスの場合にはImplを最後に付ける。 例

  interface NameOfInterface{
   ...
  }
  class NameOfInterfaceImpl{
   ...
  }

抽象クラスはAbstractを前に付ける。

   class AbstractVivaHoge{
   ...
   }

関数

関数は小文字の動詞で始まり名詞で終わる。

   public void getInstance(){
   ...
   }

定数

C/C++の#defineと同じく全て大文字でかつアンダースコアをつないで付ける。

   static final int DEFAULT_ACCESS_LIMIT = 15;

インスタンス

インスタンスは小文字でつける。

   class Sample {
     ...
   }
   Sample sample;
   sample.setArg( ... );

配列

配列の宣言はType[] arrayNameとする。type array[]は使用しない。名前にはArrayを最後に付ける。

  String[255] nameArray;

パッケージ名

極力省略形は使わず、必要となるもののみをimportする。

javadoc

javadocサンプルを以下に示す。

 JavaDocサンプル
 
 /**
  * Outline of Class(クラス概要)
  * ピリオド(.)または句点(。)で終わるところまでが、クラス一覧の概要に説明されるところであり、
  * ピリオド以降は説明の概要には含まれず、クラスの説明に含まれる。
  * このように、JavadocにはHTMLタグを使用することができる。
  * </pre>
  * @author tanuma
  * @author nakai
  * @version 1.0
  * @since 1.0
  */
 public class SampleDoc{
 
   /**
    * @serial 直列化可能データの説明
    */
   private int x;
 
   /**
    * Validates a chess move.
    * @author kubota
    * @param theFromFile File of piece being moved
    * @param theFromRank Rank of piece being moved
    * @param theToFile   File of destination square
    * @param theToRank   Rank of destination square
    * @return true if a valid chess move or false if invalid
    */
   boolean isValidMove(int theFromFile, int theFromRank, int theToFile, int theToRank)
   {
      ...
   }
 
   /**
    * Outline of method(関数説明)
    * @param int Outline(引数)
    * @throws SomeException 例外の説明
    * @throws Exception 例外の説明
    * @return String型の値
    * @see "関連"
    */
   String add( int inint ) throws SomeException, Exception {
     
   }
 }

そのほか

内部変数はなるべくprotected(not private)に格納し、getter/setterでアクセスを提供する。
HashMapやListは可能な限りIteratorでアクセスすること。
synchronizedはclassではなく、部分に適用すること。
class内classが使える場合はなるべく活用すること。 Pour vous inscrire maintenir votre numéro, vous aurez votre compte propriétaire (obligatoire à votre portabilité du numéro) numero rio. Vous obtiendrez êtes certain d'obtenir pour par entrer en contact avec la voix tonus de la voix du serveur ou du service à la clientèle support clients votre actuel entreprise rio bouygues . Vous ne certainement get un SMS avec vos . Avec votre propre rio orange, alors vous êtes capable d' la offre de de votre choix respectifs sur orange orange .