Question

我有一个接口IFoo（不是真名）我正在尝试编写Javadoc - 这是一个通过JSR223暴露给Rhino / Jython脚本的包，这个接口是唯一暴露的

它有许多相当简单的方法。其中许多是豆类，但有些不是。

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();

我的问题是，这些方法中的许多都形成了自然群体。实现这一目标的一种方法，就像Sun选择的那样（我已经看过一些Swing类），就是选择每个组中的一个方法并将大部分相关信息放在其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 */
}

任何人都可以帮助我，或解释为什么这是一个坏主意？

Answer 1

啊哈，让它运行起来，在标题和<a name="abcd">行中使用<a href="#abcd"> / @see标记对。此语法的参考位于javadoc reference for @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 */
}

javadoc：引用类头中的概念？

1 个答案: