Indentation

概要

ソースコードのインデントに一貫性がある際に獲得できる実績です． インデントに整合性を持たせることにより，可読性が上がり，わかりやすいコードとなります．

タイトル
Do as Romans do

この実績には，以下のルールが含まれます：

• CommentsIndentation

CommentsIndentation

コメントのインデントがその前後のコードと同一であるかをチェックします．

コード例

/**
 *  適切なコメントです
 */
boolean bool = true;


   /** !!!
    *  コメントが下のコードとずれています
    */
double d = 3.14;

public void foo1() {
   foo2();
   // 適切なコメントです
}

 public void foo2() {
      // !!! コメントが下のコードとずれています
   foo3();
 }

このルールのチェックには，Checkstyleの CommentsIndentation を用いています．

ちなみに

/** (内容) */ という形式のコメントは， Javadoc を生成するためのコメントです． Javadocとは，JavaのソースコードからHTML形式のAPI仕様書を生成するもののであり，決まった形式に従ってコメントを書くことによって自動的に仕様書を生成することができます．

Javadocには，　Javadocタグ と呼ばれるタグが存在しており，これらを記述することによって特定の意味を表すことができます．

一例：

タグ	記述内容
@author	開発者名を記述する
@deprecated	廃止されたクラスやメソッドに付けられる．コンパイル時にこれがつけられたメソッドを使用すると警告を発する
@exception	メソッドが投げる例外クラスとその説明を記述する． @throws も同様
@param	メソッドの引数や総称型のパラメータを記述する．引数名と引数の概要を記述する
@return	メソッドの戻り値を記述する

MissingOverride の注釈も合わせてご覧ください．

参考文献:

• Javadoc - Wikipedia
• javadoc - Oracle Docs