Мне нравится помещать мой адрес электронной почты в теги @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:[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 { }
{@link} - это разметка Javadoc. Однако Javadocs - это HTML, поэтому вы можете просто использовать
/**
* Embed HTML directly into the Javadoc.
*
* @author <a href="mailto:[email protected]">Benoit St-Pierre</a>
*/
public class Useless { }
Хорошая идея или нет - это другое дело.: -)