是否允许使用javadoc标记嵌套{@code {@link}}?
问题描述:
我想在javadoc中的代码标记内放置一个链接。以下是我的尝试。是否允许使用javadoc标记嵌套{@code {@link}}?
/**
* This method builds XML.
* <pre>
* {@code
* <Person {@link #companyId}='1234'/>
* }
* </pre>
**/
但是在生成的Javadoc中,链接不存在。字符串{@link #companyId}='1234'
即将到来。
- 是否允许嵌套javadoc标签?
- 有没有办法在代码中添加链接?
答
这取决于标签。 {@code ...}
标签按原样解释其内容,即避免将内容解释为Javadoc或HTML。它与{@link ... }
标签的内容类似。
这里是一个解决办法:
/**
* This method builds XML.
* <pre>
* {@code <Person }{@link #companyId}{@code ='1234'/>}
* </pre>
**/
答
在Eclipse中,至少,它的工作原理使用以下的任何根据,如果你之前或链接后要额外编码的文本上。
{@code {@link foo}
{@code {@link foo} {@code bar}
{@code baz}{@code {@link foo}
{@code baz}{@code {@link foo} {@code bar}
无与伦比的大括号和独立@code
注解是必要的,以便为这个工作。如果您不想在javadoc中输入foo
和bar
之间的空格,则可以删除最后一个@code
之前的空格,尽管对于baz
和foo
之间的空格不能执行该空格。
eclipse使用的JavaDoc解析器成功地将其转换为带有代码格式的链接,所以它至少适用于临时使用。然而,这并不是最佳实践,并且可能在未来发生变化,所以如果您正在编写的代码将在大约一年后仍然可用,那么您应该使用Paulo的解决方案。
如果您打算投下一个问题,请告诉用户他们的问题出了什么问题。 – prolink007