0

Javadoc を作成しようとしているインターフェースIFoo(本名ではない) があります。これは、JSR223 を介して Rhino/Jython スクリプトに公開されるパッケージであり、この 1 つのインターフェースだけが公開されます。

かなり単純な方法が多数あります。それらの多くは豆ですが、そうでないものもあります。

public void setBar(double x);
public double getBar();
public void setBigQuux(int n);
public int getBigQuux();
public void setLittleQuux(int n);
public int getLittleQuux();
public void clearQuuxes();

私の質問は、これらの方法の多くが自然なグループを形成するということです。これを行う 1 つの方法は、Sun が選択したように思われます (私はいくつかの Swing クラスを見てきました)、各グループの 1 つのメソッドを選択し、ほとんどの関連情報をその javadoc に入れ、次に他のメソッドをリンクすることです。@seeタグ付き。密接に関連するメソッドのグループを文書化する別の方法 (私にはより良い方法のように思えます) は、クラスの Javadoc ヘッダーにセクションを配置し、次に簡単な要約をメソッド ヘッダーに配置しますが、ヘッダーを参照することです。これを行う方法がわかりません：

/**
 * Foo
 * <p>
 * Quuxes: these are magic knobs that control quux content. A foo has a big quux
 * and a little quux. (etc) (I want to link here from the quux-related methods)
 */
interface IFoo    
{
  /**
   * Sets the big quux
   * @param n new value
   * @see ???? how to refer to the quux section of the class header?
   */
  public void setBigQuux(int n);
  /**
   * Gets the big quux
   * @return big quux 
   * @see ???? how to refer to the quux section of the class header?
   */
  public int getBigQuux();
  /* etc */
}

誰かが私を助けてくれますか、またはこれが悪い考えである理由を説明できますか?

4

1 に答える 1

1

ああ、ヘッダーと行で<a name="abcd">/<a href="#abcd">タグのペアを使用して、機能しました@see。この構文のリファレンスは、 のjavadoc リファレンスに@seeあります。

/**
 * Foo
 * <p>
 * <a name="quuxes">Quuxes</a>:
 * these are magic knobs that control quux content. A foo has a big quux
 * and a little quux. (etc) (I want to link here from the quux-related methods)
 */
interface IFoo    
{
  /**
   * Sets the big quux
   * @param n new value
   * @see <a href="#quuxes">quuxes</a>
   * @see #getBigQuux
   */
  public void setBigQuux(int n);
  /**
   * Gets the big quux
   * @return big quux 
   * @see <a href="#quuxes">quuxes</a>
   * @see #setBigQuux
   */
  public int getBigQuux();
  /* etc */
}
于 2012-05-15T19:16:50.847 に答える