构建之法阅读笔记02

今天着重阅读了《构建之法》第四章两人合作的部分,讲一下我的感受

如今现代软件软件产业经过几十年的发展,一个软件有一个人单枪匹马地完成已经很少见,软件都是在相互合作中完成的,那么伴随而来的问题便是能否读懂“合作队友的代码”,那么代码规范便来了,由于这部分在我们的日常编写代码中十分有意义,并且我自己本人的代码也很不规范,今天就代码规范这一问题详细的写在博客园中。

代码规范可分为两个部分:

代码风格规范。

代码设计规范。

代码风格的原则是:简明、易读、无二义性。

缩进:4个空格的距离从可读性上来说,正好。

行宽:限制为100字符

括号:在复杂的条件表达式中,用括号清楚的表示逻辑优先级

断行与空白的()行:

if(condition)

{

dosomething();

}

else

{

dosomethingelse();

}

分行:不要把多个变量定义在一行上

命名:命名的目的,应该是程序员一眼就能看出变量的类型,避免用错。

现在很多程序中的变量名太长,没有必要,建议:

1、在变量名中不要提到类型或其它语法方面的描述。例如一个表示全年假日的列表变量,不用写arrayListofholidays,可以直接写holidays。

2、避免过多的描述。例如一个变量是游戏中最后出现的大boss,不用写thefinalBottleMostBoss,可以直接写boss

3、如果信息可以从上下文中得到,那么此类信息就不必写在变量名中。

4、避免可要可不要的修饰词。例如state,data,value,engine,entity,instance,object。

下划线:用来分隔变量名字中的作用域标注和变量的语义。

大小写:有多个单词组成的变量名,所有单词首字母大写。

注释:注释是为了解释程序做什么(What)、为什么这么做(Why),以及要特别注意的地方。

以上就是代码风格规范,希望能对自己以后的代码风格有所影响。

再就是印象比较深的是代码复审部分

代码复审的目的:

    1.找出代码的错误:编码错误和不符合团队代码规范问题

    2.发现逻辑错误

    3.发现算法错误

    4.发现潜在的错误和回归性错误

    5.发现可能需要改进的地方

    6.教育(互相教育)开发人员,传授经验。

为什么要进行代码复审?

不管多么厉害的开发者都不可能做到完美,若进行项目后期在发现问题,那么修复的成本将是巨大的,代码复审正是要在早期发现问题并解决。

 

原文地址:https://www.cnblogs.com/1061321925wu/p/11059738.html