您的位置:首页 > 编程语言 > Java开发

java开发上Eclipse中的注释

2015-01-20 11:00 141 查看
java开发中的注释
此文章只要说以下三方面:
一、为什么要注释。
众所周知软件开发不是一个人所能完成的事情,一定要合作。注释有哪方面的优点呢:(1)让程序可读性高。(2)让使用都更加方便地便用。(3)调试程度出错可以快速找到当事人修改代码等等。
所以,作为一个优秀的程序员,一定要养成一个写注释的好习惯。但是要怎么样才可以让这个习惯更加好呢?以下由坛子为你介绍。
二、如何去注释。
模板如:
对函数如:

想当然这些生成一定是有它的模板和函数的:
修改的位置:Window->Preference->java->Code Style->Code Template
用相应的函数去设置:
(1)文件(Files)注释标签:
目前没有用到,可以不用设置。

(2)类型(Types)注释标签(类的注释):

规范:

/**
* 类的描述
* @authoryourname
* @Time 2012-11-20 14:49:01
*
*/

注释的pattern:

/**

* @Description:${todo}

* @author:${user}

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

*/

(3)字段(Fields)注释标签:

/**

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

*/

暂时用不到

(4)构造函数标签(Constructor):

规范:

/**

* 构造方法的描述

* @param name

* 按钮的上显示的文字

*/

(5)方法(Methods)标签:(接口和其实现类的方法,都要加注释)

注释规范:

/**

* 为按钮添加颜色

*@param color

按钮的颜色

*@return

*@exception (方法有异常的话加)

* @author Administrator

* @Time 2012-11-20 15:02:29

*/

Pattern:

/**

* @Description:${todo}

* ${tags}

* ${return_type}

* @exception:

* @author: ${user}

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

*/

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

(7)代表方法(Delegate Methods)标签:

(8)getter方法标签:

(9)setter方法标签:

这些暂时没有定义,可以按照自己的方式添加注释。
三、注释的函数有哪些。
函数可参考位置
内容来自用户分享和网络整理,不保证内容的准确性,如有侵权内容,可联系管理员处理 点击这里给我发消息
标签: