Quelle est la bonne façon d'inclure un email dans Javadoc?

Question

J'aime mettre mon adresse e-mail dans @author tags et je voudrais qu'ils soient cliquables mailto: liens dans le Javadoc généré.

Comment dois-je procéder correctement?

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

Le {@link} est balisage spécifique Javadoc. Javadocs, cependant, sont HTML - vous pouvez simplement utiliser

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

Que ce soit une bonne idée ou pas est une autre affaire. :-)