- 首先需要对代码加上文档的注释,比如下面这样:
- package?wz.learning;??
- ??
? - /**?
- ?*?Title:Person<br>?
- ?*?Description:?
- ?*?Company:SKJP?
- ?*[email protected]?xiashengwang?
- ?*[email protected]?1.0?
- ?*/??
- public?class?PersonWZ?{??
- ????/**?
- ?????*?这是Person的构造函数?
- ?????*[email protected]?name?Person的名字—?
- ?????*/??
- ????public?PersonWZ(String?name){??
- ??????????
? - ????}??
- ??????
? - ????/**?
- ?????*?这是读取方法?
- ?????*[email protected]?bookName?书名?
- ?????*[email protected]?time?读书的时间?
- ?????*[email protected]?返回读书的次数?
- ?????*/??
- ????public?int?Read(String?bookName,?int?time){??
- ????????return?0;??
- ????}??
- }??
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,就可以看到我们的注释了。
时间: 2024-10-05 15:26:42