Javaコード注釈におけるハイパーリンクの使用
1716 ワード
1.使用
クラス名とメソッド、フィールド名の間には
例:
効果:(生成
See Also: TestUtils, tech.simter.start.r2dbc.TestUtils, Object#clone(), tech.simter.start.r2dbc.TestUtils#equals(Object), google.com, bing.com
2.使用
例:
効果:
参照オブジェクトのクローン方法とObject.equals(Object)
3.標準htmlタグaを直接使用する
外部リンクを作成する唯一の方法で、上記の
例:
効果:
Google.comを参照してください.
@see
Javaのクラス、メソッド、フィールドにリンクしたり、外部リンク(標準htmlタグaを使用)にリンクしたりすることができます.フォーマットは:@see className
@see fully-qualified-className
@see fully-qualified-className#fieldName
@see fully-qualified-className#methodName
@see fully-qualified-className#methodName(argumentType)
@see the-label
@see link1 link2 ...
クラス名とメソッド、フィールド名の間には
@author
番で接続されています.例:
/**
* @see TestUtils
* @see tech.simter.start.r2dbc.TestUtils
* @see tech.simter.start.r2dbc.TestUtils#id
* @see Object#clone()
* @see tech.simter.start.r2dbc.TestUtils#equals(Object)
* @see google.com bing.com
*/
効果:(生成
#
)See Also: TestUtils, tech.simter.start.r2dbc.TestUtils, Object#clone(), tech.simter.start.r2dbc.TestUtils#equals(Object), google.com, bing.com
2.使用
See Also: link1, link2, ...
または@link
Javaのクラス、メソッド、フィールドのみにリンクすることができ、外部リンクにリンクすることはできません.コメントテキストにインラインします.フォーマットは@linkplain
{@link }
の値は、上記
のクラス、フィールド、メソッドのフォーマットと同じです.@see
を省略すると、黙認表示
.例:
/**
* {@link Object#clone() } {@link Object#equals(Object) }
*/
効果:
参照オブジェクトのクローン方法とObject.equals(Object)
3.標準htmlタグaを直接使用する
外部リンクを作成する唯一の方法で、上記の
外部リンクもこの方法を使用します.例:
/**
* google.com。
*/
効果:
Google.comを参照してください.