1、eclipse导出javadoc
-私有方法导出
-私有方法导出
2、eclipse导出设置-类文件字符集
-encoding UTF-8 -charset UTF-8
3、文件头说明单一个星号
/*
* Copyright (C) 2006-2014 Tuniu All rights reserved
* Author:huangcangbai
* Date:2014年5月23日
* Description:
*/
4、类说明
/**
* 占位反馈<br>
* 供确认管理调用
* @author huangcangbai
* @see com.tuniu.midway.ord.occupy.vo.OccupyFeedbackRequest
*/
5、成员变量注释
/**
* TSP客户端
*/
6、方法、成员变量注释
/**
* 占位反馈<br>
* <p>确认管理调用该方式,将占位结果反馈给订单<br>
* @param occupyFeedbackRequest 占位结果
* @throws ErrorCodeException 异常
*/
7、另请参见
如:另请参见某类的某方法
@see com.tuniu.midway.ord.occupy.vo.OccupyFeedbackRequest#getData()
8、javadoc注释,及注释掉的代码
javadoc注释: 用/** … */的注释将会被认为是注释文档而出现在javadoc里面
注释掉的代码: 使用/* … */的注释, 会被javadoc生成所忽略
9、链接文字
语法:{@link package.class#member label}
Label为链接文字。
package.class#member将被自动转换成指向package.class的member文件的URL。
如:<p>{@link com.tuniu.midway.ord.occupy.vo.OccupyFeedbackRequest#getData() 获取数据}
10、类、属性或方法的简述和详细描述
/**
*
简述
<br>
* The Graphics context cannot be used after being disposed of.
* While the finalization process of the garbage collector will
* also dispose of the same system resources, due to the number
* of Graphics objects that can be created in short time frames
* it is preferable to manually free the associated resources
* using this method rather than to rely on a finalization
* process which may not happen for a long period of time.
*/
注意:简述后边跟一个html换行标签。
详细描述用标点符号分割,不需要加入html标签,生成的javadoc中的详细信息将会一行行满后自动换行。