我使用javadoc来记录我的类和方法.我也想在我的软件包中添加一些概述信息.我喜欢Eclipse在键入后为每个类或方法创建匹配的Doc Comment的存根/**<Enter>.Eclipse也有一种生成package.html文件的简单方法吗?
Von*_*onC 51
4年后更新(2013年10月)
javabeangrinder的回答(upvoted)提到了以下技巧:
要
package-info.java在现有包中创建文件:
package-info.java.new->package.Create package.info.java复选框.Finish原始答案(2009年5月)
没有模板或向导可以轻松创建package.html文件.
正如mmyers在他的评论中所说,因为Java1.5,创建的正确文件将是package-info.java.
该文件不仅可以用于javadoc,还可以用于包级注释(如此处所示).
有一个已打开的Bug(#86168)要求创建一个向导package-info.java(因为类向导不允许使用该package-info名称).
自2005年以来,对该主题的反思已经开始!问题是任何解决方案都应该以一种有助于1.4代码的方式实现.
当前的解决方法是创建package-info.java一个text文件.
从那时起,package-info.java表现为普通的Java类,Eclipse将package-info.class文件放在输出文件夹中.
在Javadocs使用正确构建package-info.java,而不是package.html文件.
alt text http://jmdoudoux.developpez.com/cours/developpons/java/images/jaxb006.png
注意(回应草莓的评论):
既希望一个在Javadoc视图中包概述在package-info.java预览.
到目前为止,尚未提出/实施任何补丁.
对该功能的添加根本没有足够的要求.
jav*_*der 15
在日食中
由于package-info.java不是类的有效标识符,因此无法在Eclipse中将其创建为类.
我发现当你创建一个新包时,有一个复选框来检查你是否想要一个package-info.java.
要在现有包中创建package-info.java文件:
Nat*_*tie 13
该JAutodoc插件做的这一个伟大的工作,以及所有其他文档的需求.安装并配置插件并右键单击该包,然后单击JAutodoc> Add Package Javadoc
有可用于包.java或.html文档的配置和模板.
这个插件还可以很好地标准化所有Javadoc需求,并进行大量定制.
http://jautodoc.sourceforge.net/
| 归档时间: |
|
| 查看次数: |
24063 次 |
| 最近记录: |