java - Javadoc 是否有一些好的和现代的替代品?

标签 java documentation javadoc

让我们面对现实吧:您无需成为设计师即可看到这一点 默认 Javadoc 看起来很丑

网络上有一些资源提供了重新设计的 Javadoc。但默认行为代表产品,应该是相当好看的。

另一个问题是,与其他类似资源相比,Javadoc 的可用性不是最新的。

使用 Firefox 的快速搜索很难导航特别大的项目。

实际问题:
是否有任何能够浏览的独立(桌面)应用程序 以比浏览器更有用的方式现有的 Javadoc?
我正在考虑类似 Mono 的文档浏览器。

理论题:
有谁知道,如果有一些发展 Javadoc 的计划,在 以某种方式标准化?
编辑: A useful link to Sun' wiki on this topic .

最佳答案

我创建了一个 Markdown (java) Doclet这将采用 Markdown 格式文本中的源注释并创建相同的 HTML Javadocs。

新的 doclet 还对文本进行了一些重新样式设置,但生成的 HTML 在此阶段没有更改。

这有助于解决 HTML-in-java-commenting 问题,这可能是当前 Javadoc 最大的可用性问题。

关于java - Javadoc 是否有一些好的和现代的替代品?,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/1026553/

相关文章:

java - 将新的 JavaDoc 附加到来自 super 方法的现有 JavaDoc

java - 简单的 XML 框架 : Strings in elementlist not having namespace prefix when serializing

java - 比 jdb 更好的 Java 远程调试器?

javascript - Couchdb Javascript 引用

ios - 如何在HeaderDoc中添加多行注释

java - 如何在 Javadoc 中包含 Google Analytics 片段?

java - 如何将对象或分组参数传递给 SQL IN 子句?

Java - 接口(interface)、方法需要返回一些东西吗?

rust - 如何根据功能标志有条件地执行模块级 doctest?

java - 简单的 Getter/Setter 注释