使用eclipse生成javadoc文件

来源:互联网 发布:吴京直男癌 知乎 编辑:程序博客网 时间:2024/05/22 12:12

1.1、生成javadoc。在Eclipse的Project菜单上,点Generate javadoc。一路next下去,注意在最后需要指定生成的编码(-encoding UTF-8 -charset UTF-8)。会在指定的文件夹下生成一些html。 
1.2、将javadoc打包。把生成的文件夹打包成ZIP文件。注意,index.html文件必须在包的最外层,不能有多余的文件夹结构。 
具体操作:到要打包的文件夹里面,选择所有的文件和文件夹,然后压缩;而不是直接在父文件夹上压缩。 
1.3、将生成的javadoc指定到jar包上。在Package Explorer视图中,选择jar包。右键单击Properties,在Properties中找到指定javadoc的页。如果想指定到文件夹,则选用URL方式;如果想指定到ZIP包,则选择用archive方式。 
至此,我们已经可以使用这个jar包的javadoc了。具体有两个用途,首先保证了调用方法的形参,其次可以在javadoc视图中看到类、方法、属性的javadoc。这里已经可以圆满的解决参数的形参问题了。 
在使用的时候,还有非常棘手的乱码问题,不光光是要设置project的编码,还要设置workspace的编码。具体做法是,首选项>>Workspace>>Text file encoding。 
1.4、额外的,可以把javadoc打成chm。使用“powerCHM 中文”,但是生成的有一些网页是乱码,似乎解决不了。 
原创粉丝点击