相信在以后的工作中,肯定是多人开发一个项目的,除非你很厉害喜欢单干,那么这个时候规范就显得特别重要了,所谓三流公司卖技术,二流公司卖产品,一流公司卖标准就是这样的道理。
那么该如何定规范了?在这里,博主也只是一个在校的学生,所以只能说是提出自己的一点看法而已。
首先,就是数据库的规范,建议在设计数据库的时候,表和表之间的名字要有相同的标准,字段也是如此。不要说user表有个userid字段,而question表中有个question_id字段,这样在后面的编码中是会觉得很麻烦的。所以要有一个统一的标准,最后是由一个有项目开发经验的人来定规范。
还有就是类属性的规范了,建议类的属性用驼峰法的方式。
方法名称的规范,在一个中大的项目中,肯定会存在很多复杂的流程的。比如根据问题的回答状态来查找全部问题或者问题的全部问题量时,如果没规定好,就会有人用getAllCountByStatus和findAllCountByStatus两种方式,那么发现在后面的融合的时候会出现很大的漏洞的。
在这里,博主也只是一个初学者,对这些所谓的规范也是一知半解,但是要注意的一点是,就是在编写的时候,如果有规范一定要遵守规范进行编写,没有规范的话也要跟伙伴进行讨论,不然在后面会出现很大的问题的。
在后期的维护中,注释也是很重要的一部分。想一下,如果是你接手一个新的项目,然后这个时候只有一堆代码,方法中传递了一大堆参数,但是却不知道这些参数代表的是什么意思,那你的第一感觉会是什么呢?
所以说,养成一个良好的编程习惯,对你自己编写的代码尽可能的进行编写注释,不要觉得麻烦,或者说这么“简单”的东西就不用写注释了,因为等你把整个项目完成的时候,你会发现,前面写的一些功能你可能已经忘记是什么意思了,这时通过你的注释不就可以让你明白了吗?当然如果记得就更好啦,但是总该考虑后续维护的人员吧,所以注释也是考量一个程序员很重要的一个部分。
在写注释的时候,给大家几点建议,仅供参考啊!
1、 在一个类的最上面编写注释,写上作者、时间、功能等基本操作,这样下次查询最上面的注释就能简单的知道这个类是用来干嘛的了。而且最好能写上自己的电话号码,这样维护人员在不明白是什么意思的时候就可以打电话询问了。
2、 在dao、service的接口里的方法上写上注释,写清楚这个方法是用来方法的,每个参数代表的意思。如果接口中方法的返回值是map,说明在这个map中要传入什么方法,用来干嘛的,key是什么。
3、 在编写代码的时候,对需要的代码进行实时注释,这样可以很清楚每个操作时用来干嘛的了。
原文:http://www.cnblogs.com/littleQin/p/3619044.html