What's the correct way to include an email within Javadoc?

Question

I like to put my email address within @author tags and would like them to be clickable mailto: links in the generated Javadoc.

How should I go about doing this correctly?

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

The {@link} is Javadoc-specific markup. Javadocs, though, are HTML - so you can simply use

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

Whether that's a good idea or not is a different matter. :-)