Question

我使用{@see myPackage.MyClass}这样的标签用javadoc评论了我的java源代码。

我必须从终端生成带有ant的javadoc，但是我收到了这个警告：

[javadoc] src/calendar/annotation/DataType.java:11: warning - Tag @see cannot be used in inline documentation.  It can only be used in the following types of documentation: overview, package, class/interface, constructor, field, method.

在build.xml中是这一行：

<javadoc  sourcepath="${sourceDir}" destdir="${docDir}" windowtitle="MyProject" />

有人可以帮助我吗？

编辑：

我正确使用它。例如，我有

/**
 * <p>Metoda provede požadovaný dotaz do databáze za použití předaných parametrů.
 * Pokud jsou parametry nedostatečně nedefinované, SQL dotaz neexistuje nebo nastane
 * problém s komunikací, dojde k vygenerování {@see calendar.exception.LoadException}.
 * Pokud žádné entity neodpovídají požadavku, dochází k vrácení prázdného seznamu.
 * V případě, že nějaké entity odpovídají požadovanému pravidlu, jsou načteny především ty,
 * které již jsou definovány v persistenční vrstvě. Pokud tam entity nejsou zavedeny, dochází
 * k jejich načtení z databáze.</p>
 * @param entityClass
 * @param query
 * @param params
 * @return
 * @throws calendar.exception.LoadException
 */
<EntityClass extends AbstractEntity> Collection<EntityClass> find( Class<EntityClass> entityClass, String query, Map<String, Object> params ) throws LoadException;

Answer 1

不应该是@link而不是@see吗？

http://java.sun.com/j2se/1.5.0/docs/tooldocs/windows/javadoc.html#%7B%40link%7D

Answer 2

在Datatype.java中，您在代码中使用@see在Javadoc不允许的地方使用。具体来说，看起来你有类似的东西：

/**
  *...@see...
  */
void foo() {
}

它应该在哪里

/**
  * ...
  * @see bla
 /*
 void foo() {
     ...
 }

使用ant创建带标签的javadoc

2 个答案: