在Javadoc中包含电子邮件的正确方法是什么？

Question

我喜欢将我的电子邮件地址放在@author标签中,并希望它们是mailto:生成的Javadoc中的可点击链接.

我该如何正确地做到这一点？

/**
 * 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 { }

这是一个好主意是否是另一回事.:-)