问题标签 [javadoc]

我有一个没有Javadoc 的大型代码库，我想运行一个程序来编写一个包含基本Javadoc 信息的框架（例如，为每个方法的参数写入@param ...），所以我只需要填补剩下的空白。

任何人都知道一个好的解决方案吗？

编辑：

JAutodoc 是我一直在寻找的。它有 Ant 任务、一个 Eclipse 插件，并使用 Velocity 进行模板定义。

我是一个长期的 emacs 用户，我现在在 Java 中工作了大约 1/2 时间。

什么是最好的 emacs 库

1. 调试 Java
2. 代码完成/智能感知
3. Javadoc 浏览

?

我正在使用 ant 生成 javadocs，但一遍又一遍地得到这个异常 - 为什么？

我正在使用 JDK 版本1.6.0_06。

我正在使用 Eclipse 3.4 并配置了 Java 代码格式化程序，启用了Comments选项卡上的所有选项。问题是，当我格式化包含以下内容的文档注释时：

代码格式化程序在结束 HTML 中插入一个空格，打破它：

为什么？我该如何阻止这种情况发生？

这不能通过禁用“注释”选项卡上的任何选项来解决，例如“格式化 HTML 标记” 。我发现的唯一解决方法是通过禁用启用 Javadoc 注释格式和启用块注释格式选项来完全禁用 Javadoc 格式，这意味着我必须手动格式化注释块。

现在我的蚂蚁任务看起来像。

我收到了这个警告：

如何让 javadoc 正确链接到 API？我在代理后面。

为什么默认的 IntelliJ 默认类 javadoc 注释使用非标准语法？它可以用“@author jstauffer”创建一行，而不是用“用户：jstauffer”创建一行。它创建的其他行（日期和时间）可能没有可用的 javadoc 语法，但为什么不使用可用的 javadoc 语法呢？

这里有一个例子供参考：

您使用哪些工具/网站来阅读 JavaDocs？

我目前使用 Firefox，在处理 J2EE 项目时打开了 20 多个选项卡，以获取所有可用的文档，这些文档不是很有用，占用了太多内存并且不可搜索。

我对这样一个工具/网站的期望：

• 聚合来自不同位置的 JavaDocs
• 直接访问 Eclipse 中的 Ctrl+T 等类型或类似类型
• 全文搜索
• 我选择的所有 Java 库之间的交叉引用
• 对于一个工具：离线支持
• 速度

不是强制性的：

• 注释事物的可能性
• 支持不同版本的库（+ diffing ？）
• IDE 集成

编辑：

感谢您的回答。我知道大多数网站，但又给了他们一次尝试。这是我的判断：

• 内置 Eclipse/IDE 功能
  • 紧密集成
  • 离线/在线支持
• javadoconline.com（不再维护）
  • 作品
  • 干净的外观
  • 在多个版本的 api 中查找匹配项并允许轻松切换
  • 简单但有效
  • 快速地
• jdocs（离线）
  • 看起来很精致
  • 有时很慢
  • 似乎缺少一些最新版本的库（Seam 2.0.0，Hibernate Validators），但看起来您可以自己添加它们
  • IDE 集成（未测试）
  • 每个项目的wiki风格评论
• docjar.com
  • 作品
  • 快速地
  • 混乱的用户界面
• javadoc_isearch
  • Firefox的greasemonkey脚本，使浏览javadocs更容易
  • 工作顺利，完美

当我在 IDEA 中对 j2ee 类或注释使用快速文档查找 (Ctrl+Q) 时，我只会得到一个空的 javadoc。它只包含类名等基础知识。

如何将 javadoc 添加到 IDEA 提供的库中？

NetBeans 6.1 编辑器似乎不喜欢包装注释，并且代码格式化程序似乎忽略了它们。对于 JavaDoc 注释，这种行为似乎不合适，因为您最终可能会浪费大量时间手动重排段落。

我想知道是否有一些神奇的设置来获取内置代码格式化程序，或者编辑器来包装/重排 javadoc 注释？

当您将 javaDoc 注释添加到您的代码并概述您要传回的 XML 文档的结构时，表示属性的最佳方式是什么？对此有最佳做法吗？

我的 javaDoc 注释的一般结构是这样的：