java - Javadoc 的替代品?

标签 java javadoc

我已经使用 Java 多年了,除了 javadoc 之外,我真的很喜欢这种语言。 javadoc生成的文档让我感觉自己正在浏览20世纪90年代的网页。要制作一些美容文档,您必须插入晦涩的 html 标签,这使得您的评论在生成 html 文件之前几乎无法阅读。

我正在寻找 javadoc 的替代方案,reStructuredText 是我的第一选择,但没有适用于它的 doclet。另一个选择是 markdown,但它主要针对 html,所以如果我想不出任何其他方法,我将其视为最后的手段。

我也在考虑从java文件中分割注释,但这困扰了在IDE中浏览代码的开发人员。

有什么好的想法吗?

最佳答案

您可能不需要使用 Javadoc 的替代方案。 如果您使用的是 Java 7,新版本的 Javadoc 已重新设计。

以下是输出示例:Java 7 Reference

关于java - Javadoc 的替代品?,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/22670232/

相关文章:

java - 在 Spring MVC 中,当我使用完 session 作用域 bean 后,是否需要取消绑定(bind)到 session 的 bean 对象?如果是,怎么办?

java - 生成 Javadoc 时出现不需要的 'Property Summary"部分

Eclipse:如何将 JavaDoc 附加到多个 JAR 文件?

java - 通过 JSONObject 递归解析 JSON 以针对特定键获取值

java - 单击java中的DefaultMutableTreeNode时如何检测并显示所需的消息?

java - 如何从Servlet改为Struts2?

Javadoc 只生成接口(interface)注释而不生成类实现

maven-2 - 如何让 mvn checkstyle 检查我的所有 javadoc 注释内容是否都以大写字母开头?

JavaFX 2.2 javadoc?

java - 部分唤醒锁不适用于 Android Wear