[jfriends-ml 11793] Re: @Deprecated(Re: 本日 の議事録)

[Toru TAKAHASHI <tooru6.takahashi@xxxxxxxxxxxxx>]

   ""TAKAHASHI, Tomohiro" <t_takahashi@xxxxxxxxxxxxxx>"さんは書きました：

>   とすると以下のように、今までどおり Javadocのコメント部分も記入する
> 必要があるということでしょうか?
Javadocにかけると、@DeprecatedアノテーションとJavaコメントの@deprecated
を以下のパターンでソースコードに記述した場合のJavadoc生成例を示します。
やはり、両方ともに記述するほうがよい習慣と言えると思います。

(1)ソースコード
    @Deprecated
    public static void func() {
        System.out.println("Test Deprecated");
    }

    /**
     * @deprecated 代りに、processメソッドを使用して下さい。
     */
    public static void proc() {
    }

    /**
     * @deprecated 代りに、processメソッドを使用して下さい。
     */
    @Deprecated
    public static void procs() {
    }

(2)Javadoc生成のHTML
メソッドの概要
static void | func()                    |
            |       推奨されていません。|
------------+---------------------------+
static void | proc()
            |       推奨されていません。代わりにprocessメソッドを使用
            |       して下さい
------------+----------------------------
static void | procs()
            |       推奨されていません。代わりにprocessメソッドを使用
            |       して下さい
------------+----------------------------

メソッドの詳細
func

@Deprecated
public static void func()
      推奨されていません。
------------------------------------------
proc

public static void proc()
       推奨されていません。代わりにprocessメソッドを使用して下さい。
------------------------------------------
procs
@Deprecated
public static void proc()
       推奨されていません。代わりにprocessメソッドを使用して下さい。


---
TAKAHASHI Toru