标签: javadoc

我正在为包含它自己的枚举的类编写javadoc.有没有办法为各个枚举生成javadoc？例如,现在我有这样的事情:

/**
 * This documents "HairColor"
 */
private static enum HairColor { BLACK, BLONDE, BROWN, OTHER, RED };

但是,这仅记录了所有枚举:

有没有办法单独记录每个HairColor值？没有将枚举移入自己的类或从枚举中更改它？

在此先感谢您的帮助.

我正在开发一个带有许多同名方法的API,这些方法因签名而异,我猜这是相当常见的.它们都做同样的事情,除非他们默认初始化各种值,如果用户不想指定.作为一个易于理解的例子,请考虑

public interface Forest
{
  public Tree addTree();

  public Tree addTree(int amountOfLeaves);

  public Tree addTree(int amountOfLeaves, Fruit fruitType);

  public Tree addTree(int amountOfLeaves, int height);

  public Tree addTree(int amountOfLeaves, Fruit fruitType, int height);
}

所有这些方法所采取的基本行动是相同的; 在森林里种了一棵树.我的API用户需要了解的有关添加树的许多重要信息都适用于所有这些方法.

理想情况下,我想编写一个由所有方法使用的Javadoc块:

  /**
   * Plants a new tree in the forest. Please note that it may take
   * up to 30 years for the tree to be fully grown.
   *
   * @param amountOfLeaves desired amount of leaves. Actual amount of
   * leaves at maturity may differ …

目前,有两种方法可以将代码标记为java中的depreacted.

通过JavaDoc

/**
 * @deprecated
 */

或者作为注释:

@Deprecated

这是我的问题 - 当使用Eclipse将方法标记为已弃用时,我发现声明两者都有点太多了.我真的只想用其中一个.

但是,使用注释会给编译器提供实际有用的附加信息吗？

但是只使用注释,我无法说明为什么该方法被弃用 - 我只能用JavaDoc做到这一点,并且弃用方法而不指出为什么不好.

那么,我可以只使用其中一个吗？或者我应该真的学会指定两者？

对不起有一个可能的FAQ问题,但我找不到答案.

据我记得Eclipse,Javadoc注释中的空行显示(在源代码中的Javadoc弹出窗口中)作为换行符(具有额外的垂直间距).

然而,在Netbeans中,情况并非如此.

我可以配置Javadoc将空行解释为换行符吗？

其他问题:我可以覆盖源内Javadoc弹出窗口的默认Netbeans行为(与此相关)吗？

我在说的是:

资源

/**
 * Paragraph One
 *
 * Paragraph Two
 */
 void someMethod() { }

Eclipse解释

 Paragraph One

 Paragraph Two

Netbeans解释

 Paragraph One Paragraph Two

我想为我正在使用的开源代码库生成javadoc.但我要求Eclipse Generate JavaDoc向导提供"Javadoc命令",并且帮助没有解释这意味着什么.它是否需要javadoc二进制/ jar或其他东西的路径？

假设,作为记录代码(Javadoc)的一部分,您希望使用深度缩进来指示元素之间的关系.

如何创建嵌套列表:

• 一些元素
  • 其他一些因素
    • 还有一些其他因素

我想知道如何设置IntelliJ以指向JDK文档,以便在代码完成期间显示的文档弹出窗口将向我显示我正在查看的功能.由于某种原因,IntelliJ默认情况下无法找到JavaDocs.

我也不是100%确定文档是随随操作系统安装的JDK一起安装的.我没有在/System/Library/Frameworks/JavaVM.framework/中看到它们,但我可能看错了地方.如果没有包含它,我还想知道需要下载什么以及需要安装的位置以使JDK的JavaDocs显示在IntelliJ中.

我已经从http://www.oracle.com/technetwork/java/javase/downloads/index.html#docs下载了Java API文档,并且应该将它附加到Eclipse使用

Window-> Preferences-> Java-> Installed JREs-> Edit - >"Select rt.jar" - > Javadoc Location

并且该位置已被接受并且"验证"就好了.但是,对于我的生活,我不能让Eclipse在工具提示中显示Javadocs,当我将鼠标悬停在某个项目上时(例如在ArrayList的声明中).我还重新启动了Eclipse以试图让它工作

我究竟做错了什么？

当我在jEAee类或IDEA中的注释上使用快速文档查找(Ctrl + Q)时,我只得到一个空的javadoc.它只包含类名等基础知识.

如何将javadoc添加到libs IDEA提供给自己？

我只知道javadoc页面在线阅读,但我想下载它,以便在没有可用的网络时离线阅读.那我怎么下载呢？