我可以使用 Eclipse 将 JavaDoc 轻松添加到包中吗?

2024-01-06

我使用 javadoc 来记录我的类和方法。我也想在我的包中添加一些概述信息。我喜欢 Eclipse 在我输入后为每个类或方法创建匹配文档注释的存根/**<Enter>。 Eclipse 有没有一种简单的方法来生成package.html 文件 http://java.sun.com/j2se/javadoc/writingdoccomments/index.html#packagecomments, too?


4年后更新(2013年10月)

爪哇豆研磨机 https://stackoverflow.com/users/1782954/javabeangrinder's answer https://stackoverflow.com/a/14708381/6309(赞成)提到了以下技巧:

创建一个package-info.java现有包中的文件:

  • 右键单击您想要的包package-info.java.
  • Select new->package.
  • 检查Create package.info.java复选框。
  • 点击Finish

原始答案(2009 年 5 月)

没有模板或向导可以轻松创建 package.html 文件。

As mmyers https://stackoverflow.com/users/13531/mmyers在他的评论中说,因为Java1.5,要创建的正确文件是package-info.java http://java.sun.com/javase/6/docs/technotes/guides/javadoc/whatsnew-1.5.0.html.
该文件不仅可以用于 javadoc,还可以用于包级注释 http://www.onjava.com/pub/a/onjava/2004/04/21/declarative.html?page=3 (as 此处图示 http://weblogs.java.net/blog/kohsuke/archive/2005/09/using_jaxb_20s.html).

有一个打开的错误 (#86168) https://bugs.eclipse.org/bugs/show_bug.cgi?id=86168要求一个向导来创建package-info.java (since 类向导不允许package-info name).

自 2005 年以来,人们一直在思考这个话题!问题是任何解决方案都应该 以一种也有帮助的方式实施1.4 code.

当前的解决方法是创建一个package-info.java as a text file.
从那时起,package-info.java表现得像一个普通的 Java 类,并且 Eclipse 放置了一个package-info.class输出文件夹中的文件。
The Javadocs正确构建使用package-info.java,而不是package.html file.

alt text
(source: developpez.com http://jmdoudoux.developpez.com/cours/developpons/java/images/jaxb006.png)


注意(响应草莓 https://stackoverflow.com/users/187492/strawberry的评论):

  • 错误 77451 https://bugs.eclipse.org/bugs/show_bug.cgi?id=https://bugs.eclipse.org/bugs/show_bug.cgi?id=77451(2004 年!,对于 package.html)
  • 错误 163633 https://bugs.eclipse.org/bugs/show_bug.cgi?id=163633 and 错误 163926 https://bugs.eclipse.org/bugs/show_bug.cgi?id=163926(2006 年,针对 package-info.java)

both wish a Javadoc 中 package-info.java 中包概述的预览 看法.

到目前为止,尚未提出/实施任何补丁。
根本没有足够的需求来添加该功能。

本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系:hwhale#tublm.com(使用前将#替换为@)

我可以使用 Eclipse 将 JavaDoc 轻松添加到包中吗? 的相关文章

  • 重新索引存储库循环 - 不是 Maven

    我的 Eclipse 继续崩溃运行一个循环 显示重新索引存储库 myusername 我认为这是因为 github 但我没有检查 Maven 和 GitHub 下的 eclipse 首选项中可能导致问题的所有内容 有人可以帮忙吗 我的电脑一
  • 在 Eclipse 中的包资源管理器中,我可以按名称查找文件吗?

    您知道如何在 Eclipse 的 首选项 窗口 菜单栏 窗口 gt 首选项 中 您可以浏览层次结构 但也有一个文本搜索字段 当您在该搜索字段中输入内容时 层次结构将被过滤以仅显示与您输入的内容匹配的条目 我希望在 Package Explo
  • 为什么找不到ImageView类?

    当我转到图形布局时 我在创建第一个 Android 应用程序 pdf Android Application Development for For Dummies 中的静默切换模式 时遇到了麻烦 在 main xml 文件中插入了 Ima
  • 如何在Eclipse中配置Tesseract进行Android开发?

    我已经从事 Android 工作 6 个月了 至此我对Android开发有了基本的了解 现在我想使用 Tesseract 开发一个 OCR Android 应用程序 为此 我从 Tesseract 下载了 android ndk r6b t
  • 使用 Wildfly 在 Jersey 上使用 @PersistenceUnit 注入 EntityManagerFactory

    我尝试使用 PersistenceUnit 注入 EntityManagerFactory 但它始终为空 我认为我的 persistence xml 没问题 因为我可以使用以下代码获取 EntityManager EntityManager
  • 从列表视图启动活动

    您好 我有一个列表视图 我正在尝试通过以下方式从列表视图启动一项活动startActivity class java public class ll2 extends Activity public void onCreate Bundle
  • 如何使用蚂蚁?

    我一直试图了解 Ant 的用途 但我仍然不明白 有人可以给我一个使用 Ant 的用例吗 我可以尝试看看 Ant 为何有用以及我可以用它做什么 我在 Eclipse 中进行 Java 开发 并且刚刚开始使用 servlet 和 Google
  • PyDev 无法再调试

    我正在使用 eclipse 4 2 1 和 pydev 2 7 1 以前是 2 6 0 一切都工作正常 直到调试器突然停止工作 它打印 pydev debugger 开始 然后根本不运行程序 而是挂起 根据我在其他问题报告中找到的一些信息
  • 如何从 Ant 构建文件设置 Eclipse 构建路径和类路径?

    关于 Ant 和 Eclipse 有很多讨论 但之前的答案似乎对我没有帮助 事情是这样的 我正在尝试构建一个可以从命令行使用 Ant 成功编译的 Java 程序 更令人困惑的是 我尝试编译的程序是 Ant 本身 我真正想做的是将这个项目引入
  • 如何提高QNX6下Eclipse IDE的性能

    我们在 VMWare 环境中通过 QNX6 运行 Eclipse 速度非常慢 Eclipse 是这样启动的 usr qnx630 host qnx6 x86 usr qde eclipse eclipse data root workspa
  • eclipse juno 打开时出错

    在安装 Eclipse 并正常工作一年多后 我今天打开 Eclipse Juno 并在打开工作区时收到一条错误消息 我使用的是 Windows 8 64 位 Java 64 位和 Eclipse 64 位 此后我尝试重新安装 Java 和
  • JavaDoc @see MyClass 构造函数返回警告“未找到引用”

    我正在尝试为我的客户端库创建 javadoc 在 MyOtherClass 中 我放置了下面的 see 并收到警告 MyOtherClass 和 MyClass 都位于同一项目中的不同包中 see MyClass Constructor T
  • JUnit Eclipse 显示 System.out.print() 的

    我正在使用 JUnit 3 和 Eclipse 3 4 当我运行 JUnit 测试用例时 一切正常并且测试完美完成 唯一的事情是我想查看我正在运行的类的输出 所有类都具有一些输出值的基本 System out print 因此 当我运行测试
  • 如何消除警告:使用“$”而不是“.”对于 Eclipse 中的内部类

    我是 Android 开发新手 当我将 eclipse 和 Android SDK 更新到最新版本后 我收到警告 Use instead of for inner classes or use only lowercase letters
  • Eclipse 中的字/行计数工具

    有没有任何工具或插件可以做到这一点 CodeBlock 有这个简洁的工具 非常好 不知道它是否可以在 Eclipse 上使用 谢谢 http metrics sourceforge net http metrics sourceforge
  • 如何在 Scala 中编写 Pig UDF

    我正在尝试在 Scala 中编写 Pig UDF 使用 Eclipse 我已将 pig jar 添加为 java 构建路径中的库 这似乎解决了以下 2 个导入问题 导入 org apache pig EvalFunc 导入 org apac
  • 在 Eclipse 工作区中搜索字符串

    如何在完整的eclipse工作区中搜索字符串 我无法在 Eclipse 工作区中找到文本 但是我无法在工作区中找到指定的字符串 在顶层菜单中 选择 搜索 gt 文件搜索 然后在底部附近 在范围内 有一个选项可以选择整个工作区 为您 文件搜索
  • 如何在 Java/Eclipse 中使用特殊字符

    如何在 Java Eclipse 中使用 显示 或 等字符 当我尝试直接使用它们时 例如在源代码中 Eclipse无法保存文件 我能做些什么 编辑 如何找到 unicode 转义序列 问题是您使用的字符无法以文件设置的编码 Cp1252 表
  • Eclipse:缺少 Java 构建路径

    我正在尝试使用 Eclipse 来使用适用于 Android 的 Google SDK 教程 我能够让前两个项目正常工作 但是当运行第三个 R java 时消失了 所以我放弃了 我根据练习 3 的解决方案集制作了一个全新的包 它充满了错误
  • 尽管没有错误,但无法在 Eclipse 中运行 Android 项目

    当我尝试运行我的 Android 项目 昨天运行良好 时 我收到 您的项目包含错误 请在运行应用程序之前修复它们 对话框 但我的项目没有错误 我以前遇到过这个问题 解决方案总是清理项目 但这次没有帮助 红色 X 图标从工作区的项目中消失 然

随机推荐

  • 将参数传递给 link_to 方法

    如何使用 link to 方法通过 MVC 传递参数 view 如何使用 link to 方法来利用 remove tag 操作 issues controller rb def remove tag parameter issue rem
  • 黑莓无线安装

    我将黑莓应用程序的可交付变量上传到服务器 我希望我的用户从 URL 安装该应用程序 在上传到远程服务器之前 我在本地主机上进行了测试 没问题 但是 当我尝试从服务器下载 jad 文件时 它会显示文件内容 但不会安装应用程序 显示文字 Man
  • AngularJS 与 Django - 模板标签冲突

    我想将 AngularJS 与 Django 一起使用 但是它们都使用 作为他们的模板标签 有没有一种简单的方法可以更改两者之一以使用其他自定义模板标签 对于 Angular 1 0 您应该使用 interpolateProvider ap
  • 高优先级的自定义命令 Windows 服务

    我有一个部署在 Windows Server 2008 中的工作跟踪器 WPF 应用程序 该跟踪器应用程序正在通过 WCF 服务与 Tracker windows 服务进行通信 用户可以从 Worker Tracker GUI 应用程序创建
  • 如何使 css a:active 在点击后起作用?

    我正在尝试使菜单用作选项卡 选项卡本身工作正常 菜单链接也很棒 但我想删除活动选项卡的底部边框 使其看起来像在实际页面上 我尝试过使用 id a active但似乎只有当我按下链接时它才起作用 我也想过用 javascript 来做这件事
  • 在Python中获取Decimal的Ceil()?

    有没有办法在Python中获得高精度Decimal的ceil gt gt gt import decimal gt gt gt decimal Decimal 800000000000000000001 100000000000000000
  • 通过 NDK 在 Android 中使用 C 库

    我想做的事 我找到了一个计算音频流音高的 C 库 http www schmittmachine com dywapitchtrack html并想在 Android 中使用它 我想除了移植它之外 我还可以在 NDK 的帮助下使用它 对吧
  • 如何从正则表达式创建随机字符串

    我想从正则表达式生成一个随机字符串 example random string 0 9 4 gt 7895 random string 0 9 4 gt 0804 random string 0 9 A Z 4 gt 9ZE5 random
  • 如何在lucene中使用tf idf相似度对文档进行排名

    在创建索引和搜索查询的基本代码中 我想使用 TFIDFsimilarity 对检索到的文档进行排名 但我收到错误 无法实例化类型 TFIDFSimilarity 我的代码如下 public class TFIDF T private sta
  • 在 WooCommerce 中对特定类别的最便宜商品进行折扣

    我喜欢根据产品类别打折 Woocommerce 中最便宜的购物车商品 基于 Woocommerce 中成本较低的产品的购物车折扣 https stackoverflow com questions 49693564 cart discoun
  • org.w3c.dom.DOMException:HIERARCHY_REQUEST_ERR

    我对此已经关注太久了 无法弄清楚我做错了什么 因此 我正在尝试为某些内容生成 Xades 签名 不幸的是我总是遇到同样的错误 HIERARCHY REQUEST ERR 这是我的 XML 文档
  • 聚合时间戳数据的更好方法?

    我正在处理非统一收集的时间戳索引数据 最终将按每分钟 每小时计算统计数据 我想知道按时间段聚合的最佳方法是什么 我目前计算两个 lambda 函数 然后将两列添加到数据框中 如下所示 h lambda i pd to datetime i
  • 为什么我的桌面视图很慢?

    我正在制作一个加载了一些 NSArray 的表格视图 该单元格包含两个标签和一个加载了 URL 图像的背景图像视图 问题是 tableview 的滚动很慢 就像冻结或其他什么 我认为这是因为 Imageview 但我能做什么 这是我的一些代
  • 如何使用 Maven 程序集插件 jar-with-dependencies 在 JAR 中包含自定义文件

    我需要在最终的 JAR 中包含自定义文件 com app log4 properties 使用 jar with dependencies 时如何将一个文件添加到我的 JAR 中 现在该 JAR 中只有类文件 我在用着 mvn assemb
  • 如何对对象进行版本控制?

    为了解释这一点 请查看下面正在更改的对象 obj a 1 b 2 Version 1 obj a 2 Version 2 obj c 3 Version 3 我希望能够获得该对象的任何这些版本 例如得到obj从版本 2 开始 我不想每次更新
  • Rails 3.1:如何仅为 Web 应用程序运行初始化程序(rails 服务器/unicorn/等)

    我的网络应用程序需要加密其会话数据 我设置的是 config initializers encryptor rb require openssl require myapp encryptor MyApp Encryptor config
  • 中断运行nashorn脚本的java线程

    在下面的代码中 我让 JavaScript 在与主线程不同的单独线程中运行 该脚本是一个无限循环 因此需要以某种方式终止它 如何 脚本开始运行后 调用 cancel 不起作用 但如果我在线程初始化后调用 cancel 它将终止它 注释掉的行
  • Capistrano 和从 Github 部署网站

    因此 我有一个我认为相当简单的 Capistrano 用例 我想从 Github 部署一个 PHP 站点 但我遇到了很多问题 当我跑步时cap deploy Capistrano 能够克隆 Github 存储库 deploy update
  • 卡夫卡消费者偏移最大值?

    我正在谷歌搜索并阅读 Kafka 文档 但我无法找到消费者偏移量的最大值以及最大值之后是否存在偏移量环绕 我知道 offset 是一个 Int64 值 所以最大值是 0xFFFFFFFFFFFFFFFF 如果存在wraparound Kaf
  • 我可以使用 Eclipse 将 JavaDoc 轻松添加到包中吗?

    我使用 javadoc 来记录我的类和方法 我也想在我的包中添加一些概述信息 我喜欢 Eclipse 在我输入后为每个类或方法创建匹配文档注释的存根