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

我想把我的电子邮件地址放在

@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 { }

---

---

{@link}

是Javadoc特定的标记。不过，Javadoc是HTML，所以您可以简单地使用它

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

/**
*将HTML直接嵌入Javadoc。
*
*@作者
*/
公共类{}

---

这是不是一个好主意是另一回事。：-）

我个人会使用我的全名

@author

。虽然这可能需要转义，以避免电子邮件部分被认为是HTML标记。我仍然发现Javadoc中与HTML的紧密联系是一个非常不幸的决定：-（我编写的大多数代码都是出于内部目的，因此其他人可以方便地给我发电子邮件是很有用的。我不会在野外的代码中这样做。+1 Javadoc公约还建议经济地使用内嵌链接。{@link}应该用于指向引用类的指定包、类或成员名称的文档，而不是链接到电子邮件或URL（对于您应该使用@see的URL），这对我不起作用-我得到404。我将浏览器设置为默认（Chrome）看到了这一点：就像eclipse自动假定它是一个javadoc链接一样…@Joey为什么不写

@author My full name{@literal}

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