问题标签 [javadoc]

For questions regarding programming in ECMAScript (JavaScript/JS) and its various dialects/implementations (excluding ActionScript). Note JavaScript is NOT the same as Java! Please include all relevant tags on your question; e.g., [node.js], [jquery], [json], [reactjs], [angular], [ember.js], [vue.js], [typescript], [svelte], etc.

0 投票
3 回答
6755 浏览

java - 托管 javadoc?

我有一个托管在bitbucket上的开源项目。Bitbucket 不提供对大量小文件(即 javadocs)的托管。我在哪里可以发布 javadocs?Javadocs 必须是可浏览的,而不是作为单个存档。

0 投票
3 回答
9948 浏览

c# - 用于 C# 的 XML 注释的类似 Javadoc 的文档

我正在寻找将我的 C# XML 注释转换为文档的东西。我不喜欢 CHM 的,也不喜欢 MSDN 的外观和感觉。我喜欢使用 javadocs。它们易于导航,并且一切都可以访问。我正在寻找一种工具,可用于将代码中的注释转换为类似外观的 javadoc。

有什么可以做到这一点吗?我试过 Sandcastle 和它的各种 GUI,但他们没有做我想做的事。

0 投票
4 回答
24670 浏览

eclipse - 我可以使用 Eclipse 轻松地将 JavaDoc 添加到包中吗?

我使用 javadoc 来记录我的类和方法。我也想在我的包中添加一些概述信息。我喜欢 Eclipse 如何在我键入后为每个类或方法创建一个匹配的 Doc Comment 的存根/**<Enter>。Eclipse 是否也有一种简单的方法来生成package.html 文件

0 投票
5 回答
3305 浏览

java - 如何让 Eclipse 从我的类中显示 javadoc,而不在 jar 中包含源

我正在构建 jar,我想在没有源的情况下打包它们,但我希望 javadoc 在 eclipse 中为开发人员提供。

0 投票
1 回答
821 浏览

exception - 生成Javadoc时出现BufferOverflowException?

有没有人遇到过导致 java.nio.BufferOverflowException 的 javadoc 工具问题?

我正在尝试为带有日语注释(字符集 MS932)的代码生成 Javadoc。我认为这可能是相关的。有人知道这个问题的解决方法吗?

这是堆栈跟踪:

0 投票
2 回答
10602 浏览

netbeans - 即使定义了库,也找不到 Netbeans Javadoc

我有一个问题,Netbeans 根本无法识别外部库中的 Javadocs。我进入了库路径并指定了一个有效的 javadoc 路径(Netbeans 接受该路径而没有错误)。但即使在重新构建/打开关闭 Netbeans 之后,对于库中的所有项目,我仍然会收到“找不到 Javadoc”错误。

由于没有错误消息,我被困在哪里,我可以使用网络浏览器浏览文档。有任何想法吗?

NEtbeans 的版本是 6.5.1 文件在已添加到库属性的 ​​Javadoc 选项卡的目录中解压缩。图书馆按预期工作。

我试过清除 Netbeans 缓存无效。


我让它工作了。我删除了库,重新创建它添加了 Javadocs。现在它完美地工作了。

0 投票
2 回答
1175 浏览

ant - 使用 ant 创建带有标签的 javadoc

我已经使用 {@see myPackage.MyClass} 等标签在 javadoc 中注释了我的 java 源代码。

我必须从终端使用 ant 生成 javadoc,但我收到了这个警告:

在 build.xml 中是这一行:

有人可以帮我吗?

编辑:

我正确使用它。例如我有

0 投票
2 回答
844 浏览

version - Javadoc 版本控制

我的项目中的版本编号有一点问题。

比如说我有 4 个班级一二三四

我第一次发布这个软件时,它会被标记为版本 1.0.0

在我的 java doc 注释中,对于所有类,我将其作为 @version 1.0.0

所以现在测试将它发回,并带有第二类中的错误

我更新了第二类,现在必须发布版本 1.0.1

我现在是否更新每个班级的@version 标签?

还是我最终会在 javadoc 注释中得到一堆具有不同版本号的类?

0 投票
5 回答
3694 浏览

java - Jar from HTML

A third party library I'm utilizing provided the JavaDoc HTML and associated bin files in a zip file. How can I create a jar file from the JavaDoc HTML?

Thanks.

0 投票
2 回答
481 浏览

java - 在 JavaDoc 中使用自定义标签记录业务逻辑?

是否可以使用 JavaDoc 从自定义标签创建注释列表?我有一个要在整个代码中标记的业务规则,它确实不属于我所知道的任何现有标签。我想如果有一个标签做了类似的事情:

@note 逻辑 - 此容器中只能有 12 个小部件

这是一种对约束或要求的反向文档,我想记录这些,因为它们不一定是原始规范的一部分。我想在源代码中记录它的一个原因是源代码似乎永远不会丢失,而设计规范,嗯......(更不用说似乎没有人阅读它们)