1

オーバーロードされたメソッドでドキュメントを作成する最良の方法を探しています。

私には2つの方法があります：

/**
* does something
* @param A
* @return result
*/
public String methodA(Type1 A);

/**
 * does something
 * @param A
* @return result
*/
public String methodA(Type2 A);

両方のメソッドが同じものをレンダリングするため、オブジェクト引数を取るメソッドにドキュメントを集中させることは可能ですか? または、そうするより良い方法はありますか？

4

1 に答える 1

1

一種の「一般的な」ドキュメントを作成するという当初の意図は、そのままでは機能しないと思います。少なくともパラメーターと戻り値に注意する必要があります。

またはそうするより良い方法はありますか？

実際のドキュメントの冗長性を避けるために、@linkタグを使用できます。

これは、 Properties.load()メソッドなど、メソッドに多くのドキュメントが必要な場合に特に便利です。

于 2013-06-18T09:09:39.923 に答える