有没有一些好的和现代的替代Javadoc?

让我们面对现实:你不需要成为一个devise师,看看默认的Javadoc看起来很丑

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

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

特别是巨大的项目很难通过Firefox的快速search进行导航。

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

理论问题:
有没有人知道,如果有计划进化Javadoc,以某种标准化的方式?
编辑: 一个有用的链接到这个主题太阳维基 。

我创build了Markdown(Java)Doclet ,它将以Markdown格式的文本获取源注释,并创build相同的HTML Javadocs。

新的doclet也对文本进行了一些修改,但是生成的HTML在这个阶段没有改变。

这可以解决HTML-in-java注释问题,这可能是目前Javadoc最大的可用性问题。

我不认为Javadoc的概念已经过时了。 就我所见,这些概念早在几年前就已经在一个名为doxygen的产品中生根,该产品仍然可用于其他语言(即大量使用的Objective-C)。 即使是这样,它也是前辈 – 看看Donald Knuth用来创buildTeX( Literate编程 )的编程环境。

尽pipe如此,有一个单一的程序代码和文档来源是一个有趣的想法。

除此之外,可以使用JavaDoc工具支持的插件系统来根据您的特殊需求定制文档。 你可以提供一个插件(就像我们这样做)直接发布到可以通过networking直接访问的数据库中。 使用协作,任何人都可以提供额外的意见或澄清文件,可能会find他们的方式回到原来的来源。

Javadoc是我见过的最好的源代码自动文档生成系统。 很大一部分就是这么简单 – 如果我愿意的话,我甚至可以用5岁的手机浏览javadoc。 虽然我同意有一点改版可能是有序的,特别是JDK是一个浏览的痛苦,我不敢完全重新发明轮子,因为我们目前有一个RESTful,易于使用的解决scheme,其目的是工程几乎在任何地方。

我最近收到一封邮件,转发Sun致力于实现Javadoc HTML输出的现代化。 从上述邮件:

我们正在对JDK7的javadoc / doclet进行改进。 项目wiki页面位于http://wikis.sun.com/display/Javadoc/Home 。 作为提议改进的一部分,javadoc输出的UI将会被修改。 新的devise截图上传到项目wiki。 javadoc输出标记将被修改为有效的HTML和WCAG 2.0兼容。

所以那里肯定还有工作要做,即使有点晚了。 然而在我看来,Javadoc最大的缺点之一就是它与HTML的紧密结合。 许多类都有包含文字HTML的Javadoc,也依赖于HTML的输出。 不幸的是,我认为这不会改变。 尽pipe如此,这意味着开发人员可以随意在HTML中包含任何他们想要的内容,这些内容可能是无效的,非格式良好的等等。因此,从javadoc工具中调整输出只是其中的一部分,吨,不能改变,因此仍然存在。

至于浏览文档,我也发现HTML文档有点笨拙。 我通常在Eclipse中使用Javadoc视图。 它也有缺点(速度慢,你不能真正search),但对于大多数事情来说,它是Good Enough™。

为了回答你的实际问题,我search了一下,问了朋友,并提出了这些问题。 Forrestdoc,doclet和doxygen。

第二个问题,我会说是的,它不是很“Web-oh-twoeye”,但至less你保证在离线环境下工作,而且它的体积足够小,可以和你的API一起发货。 我展示了帧的使用,但是它对javadoc来说效果相当好。 我还没有看到有任何改变的计划。 Eclipse对javadoc有一些支持,只要阅读,解释和生成它就行了。

就我个人而言,我仍然觉得Javadoc非常有用。 特别是因为它是标准化的。 我不知道任何主要的文档风格,我发现更容易浏览(这可能是主观的,但我个人觉得MSDN可怕的使用,例如)。

对于search:使用Javadocsearch框架 ,它使得使用各种Javadoc更容易。 它可以作为Firefox的一个Userscript和谷歌浏览器扩展 。

你可能想以一种不那么激进和咄咄逼人的方式来expression这一点。 大多数人不关心技术资源是什么样的,“Web 2.0不够!” 听起来像vapid marketroidspeak。

你究竟会认为“更可用”呢? 就个人而言,我肯定会喜欢全文search和更好的用户浏览器,AJAX可能会帮助那些。

那么,关于JavaDoc的好处在于它与过时相反 – 它是任意可扩展的。 你为什么不去写一个doclet来生成你想要的那种API文档?

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

有一个DocBook doclet。 DocBook比(X)HTML更丰富的文档types,更适合描述技术内容。 从DocBook源可以生成各种不同的输出格式。

我个人希望比HTML(以及因此易于使用的)JavaDoc更具可读性的“评论文档”标准。

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

对于目前的JavaDoc,我想很多人使用JavaDoc的评论,但实际上没有文件的程度。 我确定每个人都浏览了一个API的在线JavaDoc,这个JavaDoc已经没有文档logging或者没有文档logging,因此使用起来比实际上要困难得多。

这不会被代码重组器(例如,在Eclipse中,或者在源代码提交时)帮助完全破坏您可能已经将JavaDoc注释(例如,项目列表)中的可读结构整合到一个大的文本块中,除非你真的使用两个回车你想使用一个)。

有没有人知道,如果有计划进化Javadoc,以某种标准化的方式?

相应的JSR(JSR 260)指定了对Javadoc的增强function,现在已经从JDK 7中推出了。 计划(从本网站 )计划的概述:

升级Javadoc以提供更丰富的标签集,以便更加结构化地呈现Javadoc文档。 这个JSR包括:方法和领域的分类,类和包的语义索引,静态,工厂,过时方法与普通方法的区分,属性访问者的区分,信息的组合和分割,视图的embedded,示例和常见用例的embedded,和更多。

JDK 7的整体前景相当严峻 。

JavaDoc本身非常灵活,因为你可以用一个自定义的docletreplace标准的doclet来提供满足你的项目特定需求的东西。

在我一直在研究的项目中,我们创build了一个基于HTML / XML的文档系统(在JS上使用客户端XSLT 2.0),使JavaDoc完全集成了我们的产品。 为此,使用自定义doclet来生成XML中的JavaDoc数据,这使用了tagsoup来确保代码注释中的HTML标记均已正确形成。

有了这个,我们能够使用单页面应用程序(类似于桌面工具)提供交互式用户体验,但都是在浏览器内部 – 没有任何服务器端代码/基础架构。 观众包括标准的function,如search,树导航等

下面是一个相当广泛的文档中示例入口点的链接: JavaDoc viewer示例

这也是一个图像: 在这里输入图像说明

一个聪明的seavhable javadoc查看器:

很多时候,我面临着浏览JavaDoc的问题。 我正在寻找像Adnroid文档search选项的东西。 最后我得到了这样的事情。 如果你使用Firefox,解决scheme就在这里。

  1. 安装插件GreaseMonkey,就像我们看到的那样定制网页。 (我们需要自定义任何Java文档页面,所以我们可以search类名) https://addons.mozilla.org/en-US/firefox/addon/greasemonkey/

  2. 要使greasemonkey正常工作,我们需要一些用户脚本来定制。 这可以通过greasemonkey自动下载。 从JavaDocsearch框架或JavaDoc增量search中安装userscript。

这对我很好。