Java帮助文档的生成

标签：

1. 首先需要对代码加上文档的注释，比如下面这样：
2. package?wz.learning;??
3. ?? ?
4. /**?
5. ?*?Title:Person<br>?
6. ?*?Description:?
7. ?*?Company:SKJP?
8. ?*?@author?xiashengwang?
9. ?*?@version?1.0?
10. ?*/??
11. public?class?PersonWZ?{??
12. ????/**?
13. ?????*?这是Person的构造函数?
14. ?????*?@param?name?Person的名字—?
15. ?????*/??
16. ????public?PersonWZ(String?name){??
17. ?????????? ?
18. ????}??
19. ?????? ?
20. ????/**?
21. ?????*?这是读取方法?
22. ?????*?@param?bookName?书名?
23. ?????*?@param?time?读书的时间?
24. ?????*?@return?返回读书的次数?
25. ?????*/??
26. ????public?int?Read(String?bookName,?int?time){??
27. ????????return?0;??
28. ????}??
29. }??

    2，通过eclipse生成最简单，在项目在项目列表中按右键，选择Export（导出），然后在Export(导出)对话框中选择java下的javadoc，提交到下一步。

    在Javadoc Generation对话框中有两个地方要注意的：
    javadoc command:应该选择jdk的bin/javadoc.exe
    destination:为生成文档的保存路径，可自由选择。
    按finish(完成)提交即可开始生成文档。

    注意，生成的文档可能出现乱码，可以这样解决：

    在Eclipse里 export 选 JavaDoc，在向导的最后一页的Extra JavaDoc Options 里填上参数即可
    比如项目采用的是UTF－8的编码就填：-encoding UTF-8 -charset UTF-8

    

    生成之后的文档结构如下：

    

    点开其中的index，就可以看到我们的注释了。

Java帮助文档的生成

标签：

原文地址：http://www.cnblogs.com/xiashengwang/p/5823192.html