java：Javaコーディング標準：コメント

●今回は以下のJavaコーディング標準より「６．コメント」について
http://objectclub.jp/community/codingstandard/CodingStd.pdf

●コメントの種類
①/** */
javadocコメント
html形式でドキュメント出力される
publicクラス・メソッド・フィールドに必ず付ける

②/* */
通常のコメント

③//
通常のコメント

●javadocタグ
@author 書いた人の名前
@param 引数名 説明
@return 返り値の説明
@exception 例外の名前 説明
@see string
@see URL
@see classname#methodname

※@seeは参照

●クラスコメント
/**
 *クラスの説明1.
 *<PRE>
 *クラスの説明2-1
 *クラスの説明2-2
 *</PRE>
 */
 
→クラスの説明1は…
MethodIndexに使用される
「.」または「<br>」で終わる

→クラスの説明2は…
使用例を表す場合
<PRE>タグを入れる

※HTML<PRE>
ソースに記述されたスペース・改行などをそのまま等幅フォントで表示

●契約による設計(Design by Contract)
→契約による設計とは…
プログラムコードの中に満たすべき仕様について記述を盛り込む設計
→assertステートメントを使用
http://tomame0se.blog.shinobi.jp/Entry/38/