码迷,mamicode.com
首页 > 其他好文 > 详细

代码整洁之道,新手常犯的错误。

时间:2016-08-12 23:39:00      阅读:159      评论:0      收藏:0      [点我收藏+]

标签:

        工作几年来,见过很多糟糕的代码。It是人口流动性很大的行业,如果不注重质量,那就是无数个坑。当需求变动,去改一段很长很糟糕第n手的代码时,内心是崩溃的,这就是国内IT的现状。下面是几个写出优质代码的好习惯,大部分公司没有硬性要求,所以很多人常犯这些错误。

    1.形参的命名和数量。

        变量命名的好建议是可以读出来的,有具体含义的,而不是mcount,amerber这种缩写的。

        形参的数量最多控制在四个,再多就需要建对象。

           

     2.临时变量的命名和数量。

        临时变量的命名很多人不注意,比如s1,str等等这种,具体命名建议参见上面。

        临时变量数量越少越好,声明的时候一般都在函数开始的时候声明。

 

     3.函数的长度和意义。

        函数只应该干一件主要的事,如果验证或者其他业务逻辑判断占了大部分就应该拆分。

        什么都写到一个函数里,在需求变更的时候,让人欲哭无泪,有得还必须重构才能完成需求。

 

     4.好的注释。

        接手过几个开发人员离职了,完全没有人懂的系统,深深的感觉到了注释的重要性。

        很多没有业务文档,一定要写好注释。

        还有很重要的一点是,如果改了代码一定要维护好注释。

 

     暂时就说这么多,一般能做到这几点,代码起码不会太难看。

 

代码整洁之道,新手常犯的错误。

标签:

原文地址:http://www.cnblogs.com/jiawei123/p/5766813.html

(0)
(0)
   
举报
评论 一句话评论(0
登录后才能评论!
© 2014 mamicode.com 版权所有  联系我们:gaon5@hotmail.com
迷上了代码!