Как правильно включить электронную почту в 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 { }

Является ли это хорошей идеей или нет, это другой вопрос. : -)