2

我已经使用 {@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;
4

2 回答 2

2

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

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

于 2009-05-30T14:38:17.810 回答
1

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

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

它应该在哪里

/**
  * ...
  * @see bla
 /*
 void foo() {
     ...
 }
于 2009-05-30T14:23:42.957 回答