有没有一些好的和现代的替代品Javadoc? [英] Are there some good and modern alternatives to Javadoc?

查看:637
本文介绍了有没有一些好的和现代的替代品Javadoc?的处理方法,对大家解决问题具有一定的参考价值,需要的朋友们下面随着小编来一起学习吧!

问题描述

让我们面对它:你不需要设计师看到
默认值 Javadoc看起来很丑陋



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



另一个问题是Javadoc的可用性不及时更新其他类似的资源。



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



实用问题:

是否有任何独立(桌面)应用程序能够以比浏览器更可用的方式浏览
现有的Javadoc?

<我正在考虑像Mono的文档浏览器。



理论问题:

任何人都知道,如果有一些计划演变Javadoc,以
不定式 - 标准化的方式?

编辑: 关于此主题的Sun'wiki的有用链接

解决方案

我创建了一个 Markdown(java)Doclet ,它将采用Markdown格式化文本中的源代码,并创建相同的HTML Javadoc。



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



这可以解决Java-in-java评论问题,这可能是当前Javadoc最大的可用性问题。


Let's face it: You don't need to be a designer to see that default Javadoc looks ugly.

There are some resources on the web which offer re-styled Javadoc. But the default behaviour represents the product and should be as reasonably good-looking.

Another problem is the fact that the usability of Javadoc is not up-to-date compared to other similar resources.

Especially huge projects are hard to navigate using Firefox's quick search.

Practical question:
Are there any standalone (desktop) applications which are able to browse existing Javadoc in a more usable way than a browser would?
I'm thinking about something like Mono's documentation browser.

Theoretical question:
Does anyone know, if there some plans to evolve Javadoc, in a somehow-standardized way?
EDIT: A useful link to Sun' wiki on this topic.

解决方案

I have created a Markdown (java) Doclet which will take source comments in Markdown formatted text and create the same HTML Javadocs.

The new doclet also does some restyling on the text, but the HTML generated is not changed at this stage.

That goes some way to address the HTML-in-java-commenting issues which is probably the biggest usability problem with current Javadoc.

这篇关于有没有一些好的和现代的替代品Javadoc?的文章就介绍到这了,希望我们推荐的答案对大家有所帮助,也希望大家多多支持IT屋!

查看全文
登录 关闭
扫码关注1秒登录
发送“验证码”获取 | 15天全站免登陆