在eclipse中为Jar添加javadoc遇到的问题
在新项目中引用了一个老项目生成的Jar(用Ant生成的),由于没有添加源码,在eclipse中使用该jar包时看不到注释,于是重新生成此Jar同时生成javadoc文件夹,并在eclipse中新项目的属性中添加了这个Jar的javadoc Location,这个路径能够通过eclipse里的验证,但是在eclipse编辑器中依然看不到相关的注释。
选择从浏览器中打开时,提示的路径为file:///file:/D:/doc/ , 有两个file的前缀,问题是在eclipse中添加javadoc Location时必须要带上一个前缀。
1不知这个问题怎么解决?
2有没有办法在用Ant生成Jar文件的时候直接把注释包含进Jar文件中?(这样在引用此Jar的项目里就能很方便的在eclipse中直接看到该Jar里面的注释了)
[最优解释]
使用javadoc。
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 中文”,但是生成的有一些网页是乱码,似乎解决不了。
[其他解释]
用Ant可以全部搞定。。。
[其他解释]