我可以使用Eclipse轻松地将JavaDoc添加到包中吗?
我使用javadoc来logging我的类和方法。 我想向我的软件包添加一些概述信息。 我喜欢Eclipse如何为每个类或方法创build一个匹配的文档注释的存根(stub),一旦我键入/**<Enter>
。 Eclipse是否也有一个简单的方法来生成package.html文件 ?
4年后更新(2013年10月)
javabeangrinder的答案 (upvoted)提到了下面的技巧:
要在现有包中创build
package-info.java
文件,请执行以下操作:
- 右键单击你想要
package-info.java
的包。 - select
new->package
。 - 选中
Create package.info.java
checkbox。 - 点击
Finish
原文答复(2009年5月)
没有模板或向导来轻松创buildpackage.html文件。
正如Java1.5
在评论中所说的那样,自Java1.5
以来,创build的正确文件将是package-info.java
。
该文件不仅可以用于javadoc,也可以用于包级别的注释 (如图所示 )。
有一个打开的Bug(#86168)要求向导创buildpackage-info.java
(因为类向导不允许package-info
名称 )。
关于这个话题的思考是从2005年开始的! 问题是任何解决scheme都应该以对1.4
代码有帮助的方式来实现。
目前的解决方法是创build一个package-info.java
作为text
文件。
从这一点开始, package-info.java
就像普通的Java类一样工作,Eclipse将一个package-info.class
文件放在输出文件夹中。
Javadocs
使用package-info.java
正确构build,而不是package.html
文件。
替代文字http://jmdoudoux.developpez.com/cours/developpons/javahttp://img.dovov.comjaxb006.png
注意(回应草莓的评论):
- 缺陷77451 (2004 !,对于package.html)
- bug 163633和bug 163926 (2006,对于package-info.java)
都希望 在Javadoc视图中预览Package-info.java中的包概览 。
到目前为止,没有补丁已经提出/实施。
没有足够的要求来添加该function。
在日食
由于package-info.java不是类的有效标识符,因此不能在Eclipse中将其创build为类。
我发现当你创build一个新的包时,会出现一个checkbox来检查你是否需要一个package-info.java。
要在现有包中创buildpackage-info.java文件,请执行以下操作:
- 右键单击你想要package-info.java的包。
- select新build – >包。
- 选中Create package.info.javacheckbox。
- 点击完成
JAutodoc插件在这方面做得非常好,以及您所有的其他文档需求。 安装并configuration插件并右键单击包,然后单击JAutodoc> Add Package Javadoc
有一些configuration和模板可用于.java
或.html
包文档。
这个插件也做了很大的工作,标准化了所有的Javadoc需求,并进行了大量的定制。
有一个插件,似乎创buildpackage.html文件。 我没有使用它,但有人在这里登陆可能会发现它有用。
- Eclipse:通过本地属性将source / javadoc附加到库中
- Eclipse错误:“无法创buildJava虚拟机”
- 为什么Eclipse需要这么长时间来更新Maven依赖关系?
- 我如何使Mylyn的GitHub连接器运行经过身份validation的请求?
- Perl开发的IDE最重要的特性是什么?
- 为什么Eclipse Juno 4.2运行“JPA Java Change Event Handler”进程?
- 通过Eclipse错误运行Gradle项目“system can not find System Java Compiler”
- 使用JREpath设置Eclipse
- 如何在Eclipse IDE中拆分和分离窗口/视图?