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

@seeではなく@linkにすべきではありませんか？

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 に答える