如何在基于NetBeans的项目中为我的Java代码添加JavaDoc?

9
我该如何在NetBeans中添加JavaDoc或其他文档?
我尝试了以下方法:
Tools >> Java Platform >> JavaDoc Tab >> JavaDoc.zip (in my desktop) 

但是在编辑器中,当我按下 Ctrl+Space 键时,在工具提示文本中会显示以下信息:

找不到 Javadoc。要么此项的 Javadoc 文档不存在,要么您尚未在 Java 平台管理器或库管理器中添加指定的 Javadoc。

我尝试重新启动 NetBeans,但结果如下所示:

enter image description here


1
这里没有回答吗?https://dev59.com/H17Va4cB1Zd3GeqPIUkb - planty182
可能是如何让NetBeans为Java方法显示正确的文档?的重复问题。 - Sнаđошƒаӽ
9个回答

8

在NetBeans IDE中尝试以下操作:

  1. 从主窗口选择“工具”>“Java平台管理器”。
  2. 在对话框的左面板中选择要添加Javadoc的平台。
  3. 在Javadoc选项卡中,单击“添加ZIP/文件夹”,然后指定Javadoc文件的位置。
  4. 单击“关闭”。

希望这可以帮到您。


1
@mahdi:如果你已经这样做了,那么它应该可以工作。可能需要在这样做后重新启动NetBeans。 - Harry Joy
@Harry Joy:我上传了图片,这是在重启NetBeans后的样子。 - mahdi
1
@mahdi:请发布错误信息,因为在我们的网络管理员阻止图像显示,所以我无法看到您上传的图像。作为建议,请在您的问题中添加详细信息,而不是发布答案。 - Harry Joy
@Harry Joy :Javadoc未找到。这个项目的Javadoc文档可能不存在,或者您还没有在Java平台管理器或库管理器中添加指定的Javadoc。 - mahdi
尝试这个:右键单击项目->属性->库,然后选择要添加javadoc的库,然后点击编辑按钮,从那里可以浏览javadoc文件夹。也许这对你有帮助。;-) - Harry Joy

6
如果您在项目中使用的是Maven,则按照以下步骤为所附库添加Java文档。
  1. 右键单击项目的"Dependencies"文件夹。
  2. 然后选择"Download javadoc"选项
  3. 它会下载您的库的javadoc并将其附加。
  4. 现在当您按下ctl + space时,您将看到该库的文档。
如果您想要为特定库添加javadoc,请按照Himanshu Soni建议的选项进行操作。

5

通常情况下,您不能仅仅将javadoc zip文件添加为单独的库(至少在过去这种方法对我没有起作用)。在库部分,您需要选择要添加Javadoc的库,然后添加该特定库的Javadoc jar。

重新启动Netbeans,然后应该就可以了。当然,如果该方法真的没有Javadoc,您仍然无法获得任何信息(我以前也掉进过这个陷阱!)


2
您遵循了正确的步骤,我在回答这个问题之前也经历过这个过程。由于当您谷歌这个问题时,这是第一个出现的结果,我认为很多人都会觉得这很方便,可以节省时间。解决方案如下:
解压缩您所参考的JavaDoc.zip文件(JavaSE 7文档应该是jdk-7u4-apidocs.zip),然后重复相同的过程。即:工具--> Java平台 --> javadoc(选项卡),然后点击“添加Zip /文件夹”,指向解压缩的文件夹而不是压缩文件,重新启动NetBeans即可顺畅地使用。
您可以从以下链接下载文档文件:http://www.oracle.com/technetwork/java/javase/documentation/java-se-7-doc-download-435117.html 完成上述操作后,您就可以离线使用javadoc,而无需连接互联网就可以了解APIs。
祝一切顺利!

2
"工具 >> Java平台 >> JavaDoc选项卡 >> JavaDoc.zip"
以上步骤的问题可以通过向下移动以下两个已添加到内容面板中的路径来轻松解决,如下所示。 步骤1-
  • 转到:工具 >> Java平台 >> JavaDoc选项卡,并添加要添加的ZIP /文件夹。
步骤2-
  • enter image description here
步骤3-
  • enter image description here
这就是全部内容了,如果zip文件不起作用,请先提取然后再添加。

1

在Netbeans v8.02中使用Maven项目。

首先,在Projects 窗口中查看您的项目;

  • 展开项目的Dependencies文件夹
  • 右键单击所需的*.jar文件
  • 单击download javadoc

完成!


1

1

我曾经遇到过同样的问题,我通过删除所有URL并仅添加从Oracle下载的apidocs.zip来解决它。之后重新启动您的NetBeans。

在测试之前,请确保您要查找的方法实际上存在于apidocs中。打开index.html并搜索您需要的特定package.class.method

如果不起作用,请尝试手动将apidoc.zip复制到netBeans的docs目录中: C:\ Program Files \ NetBeans 7.1.2 \ java \ docs,然后重试。


0

这对我有用,我手动将 apidoc.zip 复制到 NetBeans 的 docs 目录下:C:\Program Files\NetBeans 7.1.2\java\docs,然后重新启动我的 NetBeans。


网页内容由stack overflow 提供, 点击上面的
可以查看英文原文,
原文链接