构建之法---什么是代码规范?如何与人合作编码?

Posted 唐枫啊

tags:

篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了构建之法---什么是代码规范?如何与人合作编码?相关的知识,希望对你有一定的参考价值。

 什么是代码规范?如何与人合作编码?

   两个工程师在一起,做得最多的事就是相互看对方的代码,因此我们知道代码最终还是要给人来看,而不是机器,因此要注意代码的规范,即代码风格的规范和代码设计的规范:1.代码风格的原则就是简明易读无二义性,还应注意缩进、行宽、括号,最好是括号单独占一行。2.下划线用来分割变量名字中的作用域标注和变量的语义,所有类型和类都应该采用pascal命名法-单词首字母大写,而变量采用camel命名法-第一个单词全小写,其余单词首字母大写 3.注释是为了解释程序做什么,为什么这样做,以及要特别注意的地方。4.函数最重要的原则就是只做一件事,并且要做好,不要在构造函数中做复杂的操作,简单初始化所有数据成员即可。

    代码复审的正确定义就是:看代码是否在代码规范的框架里正确的解决了问题。代码复审分为自我复审,同伴复审,团队复审,其目的在于找出代码的错误,发现逻辑的错误,发现算法的错误,发现潜在的错误和回归性错误,教育开发人员,传授经验,让更多的成员熟悉项目各部分的代码,同时熟悉和应用领域相关的实际知识。在代码复审后,一定要注意,把所有的错误记在一个“我常犯的错误”表中,作为以后自我复审的第一步,团队也应该注意用项目管理软件来记录问题,以便日后查询。那么代码复审应该查哪些东西呢,1.概要部分 2.设计规范部分 3.代码规范部分 4.具体代码部分 5.效能 6.可读性 7.可测试性。

    程序员之间的合作会经历萌芽、磨合、规范、创造、解体阶段,要想说服别人,就要注意说话的语气和方式,少用断言,多给别人解释的机会,少直接说服别人,而是用感情分析来吸引别人,总体思想即--不是把对方推开,而是拉近对方,吸引对方加入,建立共识。举个例子,用“能不能再说说你的理由”代替“就是这样的,听我的没错”。结对编程中不好的习惯是:不拘小节、喜欢发号施令、深藏不露、跳跃很大的人。

以上是关于构建之法---什么是代码规范?如何与人合作编码?的主要内容,如果未能解决你的问题,请参考以下文章

《构建之法》阅读笔记4

《构建之法》第4章读后感

读构建之法 第四章:两人合作

第二周读书笔记《构建之法》

构建之法 第三次心得

构建之法阅读笔记03