编码原则十日谈

《编码原则十日谈》由会员上传分享，免费在线阅读，更多相关内容在行业资料-天天文库。

1、编码原则十日谈编码原则十日谈2008赵凯阿里巴巴软件（上海）有限公司2008-10-818第18页编码原则十日谈修订历史记录：修订说明修订日期文档版本作者创建2008/10/080.01赵凯18第18页编码原则十日谈目录1.前言41.1.为什么写这篇文章41.1.为什么要有编码原则/规范41.2.编码原则的两条指导思想41.2.1.客户第一51.2.2.勿以恶小而为之，勿以善小而不为51.3.高手的定义和高手追求的目标61.4.程序员的美学修养71.5.编码的十条原则72.第一天：好的软件是开发出来的，不是测出来的83.第二天：使用别的库之前，要先理解再用83.1

2、.为什么要先理解再用93.2.关于Boost93.3.关于字符串类103.4.本章总结104.第三天：写代码时，一定要想着别人105.第四天：代码是用脑子写的，而不是用手116.第五天：任何警告可能都是致命的127.第六天：使用和平台相同的编码规范138.第七天：有怪异的BUG？相信科学149.第八天：缩写要慎用，宁可写全称，也不要有歧义1510.第九天：代码不可太长，函数不可有太多的语句1511.第十天：在合适的地方加上空行和注释1611.1.关于空行1611.2.关于注释1712.总结1718第18页编码原则十日谈1.前言1.1.为什么写这篇文章编写本文档的最

3、初目的，是为研究院平台研发一部制定一套C++编码规范，以提高编码质量，进而提高软件产品的质量。在下笔之前本人一直在思考，为什么以前也有编码规范，但一直没有很好的效果呢？其实制定编码规范容易，执行编码规范难，难在要先让大家从心里接受编码规范，彻底理解编码规范的重要性。正是因为这个原因，在本文中，并没有真正灌输具体的编码规范，而是从根本的角度分析编码规范的必要性，同时定义什么是真正的高手，以及如何写好代码等。在本文档中，对编码过程，提出了十条原则，希望读者读完本文之后，分十天，每天理解一条原则。真正的规范，不是写在纸上的，而是应该留在心里面。本文档虽名为编码原则，其实

4、更重要的是倡导一种编码的艺术，所以本文档的目标读者可以是所有的开发工程师，而不仅仅是C++开发工程师。1.1.为什么要有编码原则/规范认为原则或者规范是用来约束人的想法，是完全错误的。与之相反，原则指导人们如何做事会感到身心愉悦，从而使事情变得简单，使事物趋向完美。古语说：“不以规矩，不成方圆”，并不是说没有规矩，就不让人去做方圆，就做不出方圆，而是说如果有了规矩，可以很轻松、方便地做出方圆。编码原则是也是所有原则或者规矩的一种，没有编码原则，显然也可以编码，但有了编码原则，就会让编码的过程变得轻松、简单，会让代码看上去赏心悦目，会提高编码的效率，更会提高产品的稳

5、定性、可靠性和可维护性。其实规范或者原则，在对个体的行为做了一些约束的同时，实际上建立了整体的一个秩序和稳定性，而整体的秩序和稳定性又反过来影响个体，使个体的效率更高。非常简单的一个例子就是路面上的红绿灯，有了红灯的限制之后，虽然车会暂时停一下，但整个路面的交通变得有秩序，计算下来每辆车的车速其实都在提高。这就是规范和原则带来的好处。现代软件开发，都是由团队合作完成的，一个人基本上不太可能完成一个中等规模以上的软件。如果一个软件是由很多人共同参与完成，但是代码看上去就好像是同一个人写的，那几乎可以确定，这个软件绝对是一个优秀的软件，而且注定会载入史册。这个团队也可

6、以面对任何挑战，百战百胜。1.2.编码原则的两条指导思想要编写优秀的代码，其实很简单。众多原则可以概括成两条指导思想：l客户第一l勿以恶小而为之，勿以善小而不为如果能充分理解这两句话，后面的内容其实就没有必要看下去了。当你某一天已经忘掉这篇文档，但编写出来的代码仍然美观，程序仍然稳定，别人在看你代码的时候不会抱怨的时候，说明你已经完全理解这两句话了。本小节会对这两条指导思想做一个详细的说明。18第18页编码原则十日谈1.1.1.客户第一客户第一是最重要的。客户第一，简单的四个字里，蕴藏着大智慧。做到客户第一，让客户满意；客户满意了，自己当然会得到更多。这其实就是预

7、先取之，必先予之的道理。从广义上讲，任何自己以外的人，都可以算作是客户。从编码的角度来看，以下人员都可以称之为客户：l调用你模块的人l可能阅读你代码的人l可能拷贝你代码的人l可能修改你代码的人l测试人员l……从这个角度上看，在一个团队里，每个人都是你的客户，而你同时也是每个人的客户，任何人都不可能独善其身。所以在编写代码的时候，心里一定不能只想着仅完成自己的工作，更重要的是要考虑客户使用你的产品（代码）的成本。很简单的道理，如果你不考虑客户第一，那么别人在用你的代码时就会迷惘，就必须要花费更多的时间，同时也会经常过来问你，这样你也浪费了很多时间，计算下来大家的时间

8、都浪费了。