javadocの書き方

情報

言語(java、php、javascript)でかなり書き方が違う。特にタグ(@から始まる奴)の種類と変数名の定義の仕方だ。phpとjavascriptでは変数定義時に、型を宣言しなくても良いからjavadoc(風)の書き方がjavaとは異なっている。

class変数の場合

phpの場合

参照

フォーマット
@var 型名 説明

例

var $variable;
 /**
  * example of documenting a variable's type
  * @var string contains class1 information
  */
javascriptの場合

参照
特に記載がない(javaと同じでよいのかな?)
例



javaの場合

参照





フォーマット


説明を宣言の前に直接書く


例


/**
 *File型の値を格納する変数
 */
 private File file;







    
関数またはメソッドの書き方

    


    
phpの場合

    



フォーマット


@param データ型 $パラメータ名 概要


 /**
  * example of basic @param usage
  * @param bool $baz 
  * @return mixed 
  */





    
javascriptの場合

    



フォーマット


@param {型名} 説明


 /**
  * @param {String} This is a string parameter
  */
*1








    
javaの場合

    



フォーマット


@param 変数名 説明


/**
 *メソッドtest2です。<br>
 *引数があり、例外を発生することがあります。<br>
 *@param  path ファイルを作成するPATHを指定
 *@throws IOException ファイルが生成できなかった場合
 */
 public void test2(String path) throws IOException {
        file=new File(path);
 }






*1:返り値(しばしば「返り血」とタイプミス)の場合は、@typeとするそうな。。。ややこしい