使用 ant 创建带有标签的 javadoc答案

【问题标题】：Creating javadoc with tags using ant使用 ant 创建带有标签的 javadoc
【发布时间】：2010-10-30 02:39:43
【问题描述】：

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

【问题讨论】：

Netbeans IDE 中的弹出提示接受我的 javadoc 并毫无问题地显示它。

标签： ant javadoc

【解决方案1】：

在 Datatype.java 中，您在 Javadoc 不允许的代码注释中使用 @see。具体来说，您似乎有以下内容：

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

应该在哪里

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

【讨论】：

@see 需要在评论的末尾，而不是在中间