javadoc文档
2016-03-07 20:41
302 查看
doc
/**---------------*/是为支持jdk工具javadoc.exe而特有的注释语句
javadoc工具能从java源文件中读取该注释,并能识别注释中用@标记的特殊变量,制成heml格式的类说明文档
javadoc不但能对一个java源文件生成注释文档,而且能对目录和包生成交叉链接的html格式的类说明文档。
@author ------作者名
@version------版本标识
@parameter--------参数名及其意义
@since -----------最早出现的jdk版本
@return------------返回值
@throws --------异常类及抛出条件
@deprecated-------引起不推荐使用的警告
使用alt+shift+j-------------->生成注释
例如:
/**
* 文件上传.
*
* @param name 文件名
* @param season 时令
* @param file 文件
* @return 上传提示结果
*/
生成javadoc
--------------------------------------------------------
1.选择File-Export-javadoc
2.javadoc command选择JDK的bin目录下的javadoc.exe,选择要生成javadoc的源代码和javadoc的保存路径
3.document title输入标题
4. extra javadoc options输入(额外的java选项):如果项目采用的编码是utf-8,
需要设定参数:-encoding utf-8 -charset utf-8
否则生成的网页中文注释是乱码
/**---------------*/是为支持jdk工具javadoc.exe而特有的注释语句
javadoc工具能从java源文件中读取该注释,并能识别注释中用@标记的特殊变量,制成heml格式的类说明文档
javadoc不但能对一个java源文件生成注释文档,而且能对目录和包生成交叉链接的html格式的类说明文档。
@author ------作者名
@version------版本标识
@parameter--------参数名及其意义
@since -----------最早出现的jdk版本
@return------------返回值
@throws --------异常类及抛出条件
@deprecated-------引起不推荐使用的警告
使用alt+shift+j-------------->生成注释
例如:
/**
* 文件上传.
*
* @param name 文件名
* @param season 时令
* @param file 文件
* @return 上传提示结果
*/
生成javadoc
--------------------------------------------------------
1.选择File-Export-javadoc
2.javadoc command选择JDK的bin目录下的javadoc.exe,选择要生成javadoc的源代码和javadoc的保存路径
3.document title输入标题
4. extra javadoc options输入(额外的java选项):如果项目采用的编码是utf-8,
需要设定参数:-encoding utf-8 -charset utf-8
否则生成的网页中文注释是乱码
相关文章推荐
- Java 枚举类整理
- Java 征途:行者的地图
- 25个经典的Spring面试问答
- java 知识点梳理
- HDU 1715 大数java
- 《Java实战开发经典》第六章6.2
- Java工具
- Java中final、finally、finalize的区别
- Java设计模式学习笔记(单例模式)
- Spring Security权限管理框架
- 【转载】Java开发环境的搭建以及使用eclipse创建java项目
- Java集合框架(一)
- struts2 国际化和令牌
- spring事务异常回滚使用注意点
- java实现快速排序算法
- Java学习之多线程
- Java代码重构的几种模式
- Spring项目集成Spring-Session以及可能遇到的问题
- 一个java代码生成器的简单实现
- Struts2入门示例教程