有没有一些好的和现代的Javadoc替代品?[已关闭]

2022-08-31 12:17:54

让我们面对现实:你不需要成为一名设计师就能看到默认的Javadoc看起来很丑陋

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

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

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

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

理论问题:
有谁知道,如果有计划以某种标准化的方式发展Javadoc?
编辑:关于这个主题的Sun'wiki的有用链接


答案 1

我创建了一个Markdown(java)Doclet,它将在Markdown格式的文本中获取源注释并创建相同的HTML Javadocs。

新的 doclet 还会对文本进行一些重新设计,但生成的 HTML 在此阶段不会更改。

这在某种程度上解决了JAVA中的HTML注释问题,这可能是当前Javadoc最大的可用性问题。


答案 2

我不认为Javadoc的概念已经过时了。据我所知,这些概念植根于多年前名为doxygen的产品中,该产品仍可用于其他语言(即大量使用的Objective-C)。即使这样也有它的前身 - 看看Donald Knuth用来创建TeX(Literrate编程)的编程环境。

然而,拥有程序代码和文档的单一来源是一个有趣的想法。

除此之外,可以使用 JavaDoc 工具支持的插件系统根据您的特殊需求定制文档的呈现。您可以提供一个插件(就像我们一样),该插件直接发布到可通过Web直接访问的数据库中。使用协作,任何人都可以对文档提供其他注释或说明,这些注释或说明可能会回到原始源中。


推荐