Voir Javadocdéposer de l'information
■記述箇所 1.クラス、メソッド、クラス変数、インスタンス変数が記述された 前行には必ずJavadocコメントを記述する。 ■書式 1.共通 ・文書は体言止を用いて、簡潔に記述する。 ・文書が複数行にわたる場合は、先頭に<br>をつける。 (改行タグを先頭に付けるのは可読性の向上のためである) 2.クラス ・使用可能なJavadocタグ @version バージョン情報を記述する。 @author 初期開発者名を記述する。 @see 関連クラスを記述する。 依存関係をすべて記述する必要はなく、例えばこのクラスが 特定のクラスのためだけに存在している場合などに、その特定のクラスを記述する。 ・フォーマット /** * <br>{クラスの概要}。 * <br> * <br> * <br>■変更履歴 * <br> yyyy.MM {変更内容} * <br> * <br> * <br>Copyright (c) {新規作成年}-{最終更新年} Arcs project. All rights reserved. * * @author {開発者名}. * * @version {バージョン情報} {対応J2SE From} - {対応J2SE To} */ 記述例) /** * <br>JDBCラッパークラス。 * <br> * <br> * <br>■変更履歴 * <br> 2000.12 新規作成 * <br> 2006.07 再編・コメント修正 * <br> * <br> * <br>Copyright (c) 2000-2006 Arcs project. All rights reserved. * * @author J.Matsuo. * * @version 2.0 JDK1.2.2 - JDK1.4.8 */ public class JDBCObject { 3.メソッド ・使用可能なJavadocタグ @param 引数を記述する。 @raturn 戻り値を記述する。 @throws 発生する例外と予測される原因を記述する。 ・フォーマット /** * {メソッドの概要}。 * * * @param {変数名} {概要} * * * @return {概要} * * * @throws {例外クラス} {発生箇所} * <br> * <br>-- 主な発生ケース -- * <br>{予測される原因} */ 記述例) /** * パラメータの設定。 * * * @param pmName カラム名 * @param pmData 設定値 * * * @return 以前までの設定値 * * * @throws JDBCCommonException データ設定時に発生 * <br> * <br>-- 主な発生ケース -- * <br>指定のカラム名が存在しない場合 */ public Object setParameter( final pmName, final pmData ) throws JDBCCommonException { 4.クラス変数/インスタンス変数 ・使用可能なJavadocタグ なし ・フォーマット /** * {フィールドの概要} */ *宣言するフィールドが多く、可読性を損なう場合は /** {フィールドの概要} */ と一行で記述する。 ただし、混在は不可とする。 記述例) /** * DBコネション */ protected Connection _conn; |