por - ¿Cuál es la forma correcta de incluir un correo electrónico dentro de Javadoc?

imagenes embebidas en email

Question

Me gusta poner mi dirección de correo electrónico dentro de @author tags y me gustaría que se @author clic en mailto: enlaces en el Javadoc generado.

¿Cómo debo hacer esto correctamente?

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

{@link} es un marcado específico de Javadoc. Javadocs, sin embargo, son HTML, por lo que puede simplemente usar

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

Si esa es una buena idea o no, es un asunto diferente. :-)