我使用 javadoc 来记录我的类和方法。我也想在我的包中添加一些概述信息。我喜欢 Eclipse 如何在我键入后为每个类或方法创建一个匹配的 Doc Comment 的存根/**<Enter>
。Eclipse 是否也有一种简单的方法来生成package.html 文件?
4 回答
4 年后更新(2013 年 10 月)
javabeangrinder的回答(赞成)提到了以下技巧:
package-info.java
在现有包中创建文件:
- 右键单击您想要的包
package-info.java
。 - 选择
new->package
。 - 选中
Create package.info.java
复选框。 - 点击
Finish
原始答案(2009 年 5 月)
没有模板或向导可以轻松创建 package.html 文件。
正如mmyers在他的评论中所说,因为Java1.5
,要创建的正确文件是package-info.java
.
该文件不仅可以用于 javadocs,还可以用于包级别的注释(如此处所示)。
有一个已打开的错误 (#86168)要求使用向导来创建package-info.java
(因为类向导不允许使用package-info
name)。
自... 2005 年以来,关于该主题的思考就开始了!问题是任何解决方案都应该以一种对1.4
代码也有帮助的方式实现。
当前的解决方法是创建package-info.java
一个text
文件。
从那时起,它package-info.java
的行为就像一个普通的 Java 类,并且 Eclipse 将一个package-info.class
文件放在输出文件夹中。
是使用Javadocs
正确构建的package-info.java
,而不是package.html
文件。
(来源:developpez.com)
注意(回应Strawberry的评论):
两者都希望在 Javadoc 视图中的package-info.java 中预览包概述。
到目前为止,尚未提出/实施任何补丁。
根本没有足够的需求来添加该功能。
在日食
由于 package-info.java 不是类的有效标识符,因此不能在 Eclipse 中将其创建为类。
我发现当你创建一个新包时,有一个复选框来检查你是否需要一个 package-info.java。
要在现有包中创建 package-info.java 文件:
- 右键单击需要 package-info.java 的包。
- 选择新建-> 包。
- 选中创建 package.info.java 复选框。
- 点击完成
JAutodoc插件在这方面做得很好,也可以满足您的所有其他文档需求。安装并配置插件并右键单击包并单击JAutodoc > 添加包 Javadoc
.java
或.html
包文档有可用的配置和模板。
该插件还可以很好地标准化您的所有 Javadoc 需求,并进行大量自定义。
有一个插件似乎可以创建 package.html 文件。我没用过,但是登陆这里的人可能会觉得它很有用。