Java注释总结

Java注释总结

注释风格设置方法：

WindowàpreferencesàJavaàCode StyleàCode TemplatesàComments

javadoc注释

@author      类作者

@version     类版本

@see       转向参考

@param      方法参数说明

@return      方法返回值说明

@exception    方法异常说明

    描述内容可以使用html标签

类中：

方法中：

 

注释快捷键

对类做注释在类的上一行打出“/**”然后enter

对方法做注释在方法的上一行打出“/**”然后enter

 

模板：（引用地址http://meryvn.blog.163.com/blog/static/3696266420119811133598）

（1）文件(Files)注释标签

/**

*FileName:     ${file_name}

        * @Description: ${todo}(用一句话描述该文件做什么)

* Allrights Reserved, Designed By ZTE-ITS

*Copyright:    Copyright(C) 2010-2011

*Company       ZTE-ITS WuXi LTD.

*@author:    名字

*@version    V1.0 

*Createdate:         ${date} ${time}

*

*Modification  History:

*Date         Author        Version        Discription

*----------------------------------------------------------------------------------

*${date}       wu.zh          1.0             1.0

* Why& What is modified: <修改原因描述>

*/

（2）类型(Types)注释标签（类的注释）：

/**

*@ClassName:     ${type_name}

*@Description:${todo}(这里用一句话描述这个类的作用)

*@author:    Android_Robot

*@date:        ${date} ${time}

*

* ${tags}

*/

（3）字段(Fields)注释标签：

/**  

* @Fields ${field} : ${todo}(用一句话描述这个变量表示什么)  

*/  

（4）构造函数标签：

/**

*@Title:        ${enclosing_type}

*@Description:    ${todo}(这里用一句话描述这个方法的作用)

*@param:    ${tags}

* @throws

*/

（5）方法(Methods)标签：

/**

* @Title:${enclosing_method}

*@Description: ${todo}(这里用一句话描述这个方法的作用)

* @param:${tags}   

*@return: ${return_type}   

* @throws

*/

（6）覆盖方法(Overriding Methods)标签:

/**

*<p>Title: ${enclosing_method}</p>

*<p>Description: </p>

* ${tags}

*${see_to_overridden}

*/

（7）代表方法(Delegate Methods)标签：

/**

* ${tags}

*${see_to_target}

*/

（8）getter方法标签：

/**

*@Title:        ${enclosing_method}<BR>

*@Description: please write your description <BR>

*@return:     ${field_type} <BR>

*/

（9）setter方法标签：

/** 

*@Title:  ${enclosing_method}<BR> 

*@Description: please write your description <BR> 

*@return: ${field_type} <BR> 

*/