Was ist der richtige Weg, um eine Email in Javadoc aufzunehmen?

Question

Ich möchte meine E-Mail-Adresse innerhalb @author Tags setzen und möchte, dass sie anklickbare mailto: Links im generierten Javadoc sind.

Wie soll ich das richtig machen?

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

Die {@link} ist Javadoc spezifische Markup. Javadocs aber sind HTML - so können Sie einfach

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

verwenden Ob das eine gute Idee ist oder nicht eine andere Sache. :-)