Javadoc說明註解中如果要參照到某個類別或方法的寫法如下。
在Javadoc 說明文字中如果要參照到類別或方法,則用大括弧加上@link
,並在後面加上要參照的類別或方法名稱。如果有相同的類別名稱則在前面加上package位置,語法為:
{@link package.class#member label}
。
label
是替代名稱可不加。
例如下面在demo()
方法的Javadoc說明中參考到DemoService.doSomething(String)
。
/**
* 請參考{@link com.abc.service.DemoService#doSometing(String)}
*/
public static void demo(String str) {
...
}
參考:
沒有留言:
張貼留言