是否有一些好的和现代的 Javadoc 替代品？

让我们面对现实吧: 你不需要成为一个设计师就能看到这一点 默认 Javadoc 看起来很丑。

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

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

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

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

理论问题:
是否有人知道，如果有一些计划，以发展 Javadoc，在一个 以某种标准化的方式？
编辑: 关于这个主题的一个到 Sun 的 wiki 的有用链接。

17351 次浏览
小开

有个 DocBook 文件夹。DocBook 是一种比(X) HTML 更丰富的文档类型，更适合于描述技术内容。从 DocBook 源代码可以生成各种不同的输出格式。

小开

我不认为 Javadoc 的概念已经过时了。据我所知，这些概念是多年前植根于一个名为 doxygen 的产品中的，该产品仍然可用于其他语言(例如，它被大量使用的 Objective-C)。甚至这也有它的前辈-看看 Donald Knuth 用来创建 TeX (文学编程)的编程环境。

尽管如此，拥有一个单一的程序代码和文档来源仍然是一个有趣的想法。

除此之外，可以使用 JavaDoc 工具支持的插件系统根据您的特殊需要定制文档的表示。您可以提供一个插件(正如我们所做的那样) ，它可以直接发布到可以通过 web 直接访问的数据库中。使用协作，任何人都可以对文档提供额外的注释或说明，这些注释或说明可能会返回到原始源代码中。

小开

为了回答你的实际问题，我在谷歌上搜索并询问了一些朋友，得出了这些结论: Forrestdoc，doclet 和 doxygen。

第二个问题，我会说，是的，它不是非常“ Web-oh-twoeye”，但至少您可以保证在离线环境中工作，并且它足够小，可以与您的 API 一起发布。我不喜欢框架的使用，但是它对 javadoc 来说非常有用。我没有看到任何改变它的计划。 Eclipse 在读取、解释和生成 javadoc 方面提供了一些支持。

小开

你最好用不那么咄咄逼人和专横的方式来表达。大多数人并不关心技术资源是什么样的，并且“它还不够 Web 2.0!”听起来像是乏味的市场行话。

你觉得什么更有用？就个人而言，我当然希望有一个全文搜索和更好的使用浏览器，AJAX 可能会帮助这些。

好吧，JavaDoc 的优点在于它是过时的对立面——它是任意可扩展的。您为什么不继续编写一个 Doclet来生成您想要的那种 API 文档呢？

为什么到目前为止没有其他人这样做(显然是这种情况)是任何人的猜测-也许没有人像你一样强烈地感觉到这一点。

小开

就个人而言，我仍然觉得 Javadoc 非常有用。特别是因为它是标准化的。我不知道有什么主要的文档样式更容易导航(这很可能是主观的，但我个人认为 MSDN 使用起来很糟糕)。

对于搜索: 使用 Javadoc 搜索框架，它使得所有类型的 Javadoc 的使用变得更加容易。它可以作为 Firefox 的用户脚本和 谷歌 Chrome 扩展。

小开

Javadoc 是我见过的最好的源代码自动文档生成系统。很大程度上是因为它太简单了——如果我想的话，我甚至可以用我5岁的手机浏览 javadocs！虽然我同意有必要做一些改变，尤其是 JDK 浏览起来很痛苦，但我不敢完全重造轮子，因为我们现在拥有的是一个 REST 风格的、易于使用的解决方案，几乎可以在任何地方使用。

小开

我最近收到一封邮件，说 Sun 正在改进 Javadoc 的 HTML 输出:

我们建议对 JDK7的 javadoc/doclet 进行改进 项目维基页面位于 Http://wikis.sun.com/display/javadoc/home improvements, the UI of the javadoc output will be revamped. The new 设计截图被上传到项目 wiki 标记将被修改为与 HTML 和 WCAG2.0兼容。

所以那里肯定还有工作在进行，即使有点晚。然而，在我看来，Javadoc 最大的缺点之一是它与 HTML 的紧密耦合。很多类都有 Javadoc，它包含文字 HTML，并且依赖于输出也是 HTML。很不幸，但我想这不会随时改变。尽管如此，这意味着开发人员可以自由地在 HTML 中包含任何他们想要的内容，这些内容可能是无效的、格式不正确的等等。因此，调整 javadoc 工具的输出只是其中的一部分，另一部分不会也不能更改，因此保留了下来。

至于浏览文档，我还发现 HTML 文档有点笨拙。我通常在 Eclipse 中使用 Javadoc 视图。它也有缺点(慢，你不能真正地搜索) ，但它是足够好的大多数事情。

小开

我个人希望有一个比 HTML (因此标记繁多) JavaDoc 更易读的“注释文档”标准。

例如，这里使用的 MarkDown 非常好，在源代码中是可读的，在源代码外格式化很好。

使用当前的 JavaDoc，我想许多人使用 JavaDoc 注释，但实际上并没有尽可能地编写文档。我敢肯定每个人都浏览过 API 的在线 JavaDoc，它没有文档记录或者几乎没有文档记录，因此使用起来比应该的要困难得多。

代码重格式化程序(例如，在 Eclipse 内部，或者可能在源代码提交时)完全破坏了你可能在 JavaDoc 注释中放入的任何可读结构(例如，项目列表)到一大块文本中，除非你真的使用了两个回车符，而你希望使用一个)。

小开

有没有人知道，是否有计划以某种标准化的方式改进 Javadoc？

相应的 JSR (JSR 260)指定了对 Javadoc 的增强，已经被从 JDK 7中剔除(目前为止)。计划内容概述(来自 这个网站) :

升级 Javadoc 以提供更丰富的标记集，从而允许对 Javadoc 文档进行更结构化的表示。这个 JSR 包括: 方法和字段的分类，类和包的语义索引，静态，工厂，不推荐的方法和普通方法的区别，属性访问器的区别，组合和分割信息到视图，嵌入示例和常用用例，等等。

JDK 7的总体前景是 很残酷。

小开

我已经创建了一个 Markdown (java) Doclet，它将采取 Markdown 格式的文本和创建相同的 HTML Javadocs 源注释。

新的 doclet 也对文本进行一些重新设置，但是在这个阶段生成的 HTML 不会改变。

这在一定程度上解决了 HTML 中的 java 注释问题，这可能是当前 Javadoc 最大的可用性问题。

小开

一个智能的可搜索 javadoc 查看器:

很多时候，我都面临着浏览 JavaDoc 的问题。我在找一些类似于 Adnroid 文档搜索选项的东西。我终于得到了这样的东西。如果您使用 firefox，解决方案就在这里。

  1. 安装插件 GreaseMonkey，它的自定义网页的方式，我们看到的。(我们需要定制任何 java 文档页面，这样我们就可以搜索类名) Https://addons.mozilla.org/en-us/firefox/addon/greasemonkey/

  2. 为了让 greasemonkey 工作，我们需要一些用户定制脚本。这个可以被 Greasemonkey 自动下载。从 JavaDoc 搜索框架或 JavaDoc 增量搜索安装用户脚本。

这对我很有用。

小开

JavaDoc 本身非常灵活，因为您可以将标准 doclet 替换为自定义 doclet，以提供满足项目特定需求的内容。

在我一直致力于的项目中，我们为我们的产品创建了一个基于 HTML/XML 的文档系统(在 JS 上使用客户端 XSLT 2.0) ，该系统与 JavaDoc 完全集成。为此，我们使用了一个自定义 doclet 来生成 XML 格式的 JavaDoc 数据，这个 doclet 使用了标签汤来确保代码注释中的 HTML 标记格式良好。

通过这种方式，我们可以使用单页应用程序(类似于桌面工具)提供交互式用户体验，但都是在浏览器内部完成的——不需要任何服务器端代码/基础设施。查看器包括标准功能，如搜索，树导航等。

下面是大量文档中的一个入口点示例链接: JavaDoc 查看器示例

这里还有一张图片: enter image description here


提交答案