JavaDoc:@link to MyClass.class

时间:2014-05-03 20:08:08

标签: java javadoc

{@link Foo.class}是否有正确的JavaDoc语法?这个和{@link Foo#class}都不起作用。或者这不可能吗?

让我展开一点:

我有一个函数registerException(Class<? extends Exception> exceptionClass),可以使用registerException(IOException.class)之类的函数调用它,并开始为它编写以下JavaDoc:

/**
 * Registers a new {@link Class Class&lt;? extends Exception&gt;}
 * (e.g. <code>IOException.class</code>} that can be flattened by this handler.
 * 
 * @param exceptionClass - the exception class
 */

我在想是否可以在{@link ...}周围放置一个IOException.class

1 个答案:

答案 0 :(得分:4)

不需要.class(显然不起作用)。

如评论中所述, {@link IOException IOException.class}应该创建一个带有适当文本标签的链接。