tag javadoc edit 新建 ram tor 公司 函數 method

註釋的作用：myeclipse中java文件頭註釋格式設置，最終可用於javadoc.exe生成API文檔，同時提高了代碼的可讀性

設置方法：

windows->preferences->java->Code Style->Code Templates->comments->Type->edit

Files 新建類文件

/**
* @Title: ${file_name}
* @Package ${package_name}
* @Description: ${todo}(用一句話描述該文件做什麽)
* @author : ${user}
* @date : ${date} ${time}
* @version V1.0
*/

Types 類型文件

/** * Copyright (c) 2017 by [個人或者公司信息] * @ClassName: ${file_name} * @Description: ${todo}(用一句話描述該文件做什麽) * * @author: ${user} * @version: V1.0 * @Date: ${date} ${time} */

字段(Fields)註釋標簽：

/**
* @Fields ${field} : ${todo}(用一句話描述這個變量表示什麽)
*/
構造函數標簽：

/**
* <p>Title: </p>
* <p>Description: </p>
* ${tags}
*/

方法(Constructor & Methods)標簽：

/**
* @Title: ${enclosing_method}
* @Description: ${todo}(這裏用一句話描述這個方法的作用)
* @param ${tags} 設定文件
* @return ${return_type} 返回類型
* @throws
*/

覆蓋方法(Overriding Methods)標簽：

/* (非 Javadoc)
* <p>Title: ${enclosing_method}</p>
* <p>Description: </p>
* ${tags}
* ${see_to_overridden}
*/

代表方法(Delegate Methods)標簽：

/**
* ${tags}
* ${see_to_target}
*/
getter方法標簽：

/**
* @return ${bare_field_name}
*/

setter方法標簽：

/**
* @param ${param} 要設置的 ${bare_field_name}
*/

MyEclipse，Eclipse註釋規範模板