在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:[email protected]"} 
*/ 
public class Useless { } 

---

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

Answer 1

的{@link}是特定的Javadoc的标记。但是，Javadocs是HTML--因此您可以简单地使用

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

无论这是一个好主意还是另一回事。 :-)