首页 > 开发 > 软件使用 > 正文

规范代码-MyEclipse注释设置

2016-04-06 13:49:30  来源:极客头条
引言

对于我们这些编程人员来说不仅要学会各种快捷方式的使用而且写好注释也是我们的职业规范。尤其是后期维护,二次迭代,人员交接的时候,如果你写的代码没有一点儿注释,接手的编程人员就开始大骂了,写的都是啥一点儿注释都没有。因此我们应该注意我们的注释规范。无论是VS还是MyEclipse,首先想到的是应该能自动生成一部分注释吧,要不然怎么能节约我们的编程人员时间呢,接下来接看看MyEclipse的注释自动生成。




注释设置解说

首先,打开Window->Preference->Java->CodeStyle->Code Template ,点开comments节点,在里面设置各种各样的注释模板。如图:

            


这么多肯定不知道哪个是哪个吧,下面介绍一下我们常用的几个含义:

文件(Files)注释标签,类型(Types)注释标签(类的注释),字段(Fields)注释标签,构造函数标签,方法(Constructor& Methods)标签,覆盖方法(Overriding Methods)标签,代表方法(DelegateMethods)标签,getter方法标签,setter方法标签等等。



注释设置应用

接下来,点击一个例如Files,对其进行设置。
            



点击编辑按钮进行设置。利用这样的方法,可以对类,头文件,方法等设置注释模板啦。

这样当你新建一个类的时候,就会自动加上你给设置的模板,如图:
            




结束语

编码就像做针线活儿,粗心大意的人做出来的七扭八歪的,细心的人做出来的精巧细致。所以我们要做个心细的人,时刻注意自己的编码规范,代码注释等等,在编程中做一个有心人。

版权声明:本文为博主原创文章,未经博主允许不得转载。