在Javadoc中包含電子郵件的正確方法是什麼？

Question

我喜歡把我的電子郵件地址放在@author標籤內，並希望它們在生成的Javadoc中可點擊mailto:鏈接。

我應該如何正確地做到這一點？

/** 
* I currently do the following, but would like to have my name 
* displayed as the link rather than the email itself. 
* 
* @author {@link "mailto:my_email@email.example.com"} 
*/ 
public class Useless { } 

---

/** 
* I've tried this, but get warnings about unexpexted text where my name is. 
* 
* @author {@link "mailto:my_email@email.example.com" "Benoit St-Pierre"} 
*/ 
public class Useless { } 

Answer 1

的{@link}是特定的Javadoc的標記。但是，Javadocs是HTML--因此您可以簡單地使用

/** 
* Embed HTML directly into the Javadoc. 
* 
* @author <a href="mailto:my_email@email.exmaple.com">Benoit St-Pierre</a> 
*/ 
public class Useless { } 

無論這是一個好主意還是另一回事。 :-)