问题标签 [doclet]

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 投票
2 回答
1023 浏览

java - Java:如何使用 Javadoc 创建好看的类文档?

我想为一个 Java 类库创建 HTML 文档,其中包括

  • 编程指南信息——不仅仅是类参考
  • 参考文档中的代码示例
  • 可折叠区域

我希望它看起来很有风格。像这样的东西:

替代文字

认为Javadoc 公开了一个 doclet API,允许其他方提供集成在 Javadoc 中的文档生成。是否有一个我可以(免费)使用的 doclet 选项,它比标准的 javadoc 输出做得更好?

我试着用谷歌搜索,但没有运气。建议?

附录
我找到了 doclet.com,但我不知道如何评估这些选项。建议?

特别是,XHtmlDoclet听起来像是要解决这些问题。有人用过吗? 我无法让它工作。此外,XHTML Doclet 人员提供的示例看起来并不比从 c.1998 javadoc 生成的文档好。


相关:
为什么 Javadoc 会生成不兼容的 XHTML?

0 投票
2 回答
606 浏览

java - Java XHTML Doclet:致命异常

有没有人用过XHTML Doclet,你能提供一些关于如何让它成功工作的提示吗?

我这样运行它:

(全部在一条线上)

当我运行它时,我得到了这个:

似乎它应该工作。我究竟做错了什么?

0 投票
3 回答
844 浏览

java - Sun Xml doclet 是否仍然可用?

我正在寻找可以生成 xml 格式而不是默认 html 的 javadoc 的 doclet。经过一番搜索,我发现有一个 Sun XML doclet,以前位于http://www.sun.com/xml/developers/doclet/

但是这个链接不再有效,有人有 Sun xml doclet 的副本吗?或任何其他替代xml doclet?

0 投票
0 回答
846 浏览

eclipse - Eclipse doclet 插件

我正在寻找一个 Eclipse javadoc doclet 插件,它可以修改标准的内置javadoc 生成过程。换句话说,我想指定自定义标签,并可能在普通的 javadoc 注释中使用 wiki 语法或其他任何内容,并让生成的输出显示在将鼠标悬停在方法或类标识符上时出现的那些弹出窗口中。

需要明确的是,我不是在寻找一种在显式生成外部 javadoc 时指定 doclet 的方法。

似乎 Eclipse 使用了一些内部机制来生成弹出 javadoc,在过去一小时的谷歌搜索中,我无法找到修改该行为的插件。

任何想法或指示?谢谢!

0 投票
3 回答
3348 浏览

java - 如何在 Eclipse 中调试 Doclet?

我正在创建一个自定义 doclet,我想使用 Javadoc 插件在我的 Maven 构建中运行,但现在我想在 Eclipse 中测试/调试 Doclet。我怎样才能做到这一点?

我必须以编程方式调用 javadoc 吗?如何?

0 投票
0 回答
1261 浏览

java - 有哪些很酷的 Javadoc doclet/模板?

我真的不喜欢默认 Javadocs 的外观。我更喜欢这个的外观。我可以使用哪些其他模板/doclet 来生成更好的 JavaDoc 页面?

0 投票
1 回答
60 浏览

maven - 在创建报告时或在其他阶段生成其他工件?

我知道您只能从 Maven 中的一个 pom 创建一个工件。

我编写了一个 javadoc doclet,它创建了我的工件 (my-rest-api) 的 html 报告。此 doclet 还可以为编写集成测试创建存根请求和模型。我现在的问题是,我必须手动将生成的类复制到第三个 maven 项目(my-test-models)中才能从中创建工件。还有其他方法吗?生成的类是从源代码创建的,所以我不能只依赖 my-rest-api 工件。我可以对两个项目之间的路径进行硬编码,但我也不喜欢这样。有任何想法吗?

0 投票
1 回答
484 浏览

java - 如何从调用方检索以编程方式调用的 Javadoc doclet 的输出?

我正在编写一个工具来从预先存在的 Java 源文件中抓取 Javadoc,并通过自定义 doclet 对其进行预处理(处理的细节不相关)。我已经编写了 doclet,并且可以通过 Java文档中所示的编程 API 从我的代码中调用 doclet 。

这种机制似乎是“只写”的,因为运行 doclet 的结果(如果有的话)不能通过第一类 Java 对象传回 execute() 方法的调用者。相反,我不得不求助于诸如从 doclet 中将中间输出写入文件,然后从调用者那里读回该文件。

所以我的问题是:有什么方法可以直接在调用者处检索由我的自定义 doclet 生成的字符串?例如:

提前致谢!

0 投票
2 回答
2970 浏览

javadoc - javadoc doclet libs:运行时出现非法包名或 ClassCastException

我遇到了下一个问题:

我正在尝试在控制台(Windows 7)中运行我自己的漂亮 doclet:

这让我遇到了一大堆例外:

(总是一样的)。

然后,我在 StackOverflow 中发现有人说这是一个带注释的第三方库问题(StackOverFlow:为什么在生成 javadocs 时我得到一个 ClassCastException?)。解决方案看起来是将那些带有注释的库添加到类路径中,所以我运行了下一行:

我现在收到下一个错误:

所有库都包含在 all-libs 目录中。谁能解释我做错了什么?非常感谢 :-)

PS:我使用的是 JDK 1.6

0 投票
1 回答
2468 浏览

java - Doclets vs DocLava

我的理解是:

  • Java Doclet API 只是一个 API(由接口组成),植根于com.sun.javadoc
  • 当 Javadoc 运行时,它会查找要在运行时绑定到的 Doclet API impl
  • 如果不存在这样的 impl,则它使用一些默认值(因此您可以生成 Javadocs 而无需指定自己的 CSS 文件等)
  • Google 的 DocLava 就是这样一种 Doclet API impl

如果这是真的,那么如何指定一个不同的 Doclet impl(例如 DocLava)而不是默认值?如果我偏离了基础,那么 Javadoc 工具、Doclet API 和 DocLava 是如何相互关联的?