代码规范与代码复审

现代软件工程讲义 3 代码规范与代码复审 http://www.cnblogs.com/xinz/archive/2011/11/20/2255971.html

总述：简明、易读、无二义性

10.1 代码风格规范

10.1.1 缩进：4个空格

10.1.2 行宽：100字符

10.1.3 括号

10.1.4 断行与空白的{ }行：每个“{”和“}”各占一行

10.1.5 分行：

不要把多行语句放在一起，严格说，不要把不同的变量定义在一行上

10.1.6 命名：

“ 匈牙利命名法” 在变量面前加上有意义的前缀，就可以让程序员一眼看出变量的类型及相关的语义（C#不建议这样做）

10.1.7 下划线问题：

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

10.1.8 大小写问题：

由多个单词组成的变量名，如果全部都是小写，很不易读。一个简单的解决方案就是用大小写区分它们

Pascal -- 所有单词的第一个字母都大写

Camel -- 第一个单词全部小写，随后单词随Pascal格式，也叫lowerCamel

一个通用做法是：所有的类型/类/函数名都用Pascal形，所有变量都用Camel形式

类/类型/变量：名词或组合名词，如Member，ProductInfo等

函数则用动词或动宾组合词来表示：如get/set，RenderPage()

10.1.9 注释：
谁不会写注释？但是，需要注释什么？
不要注释程序是怎么工作的（ How ），你的程序本身就应该能说明这一问题。
//this loop starts the i from 0 to len, in each step, it
// does SomeThing
for (i = 0; i<len; i++)
{
          DoSomeThing();
}
以上的注释是多余的。
注释是用来解释程序做什么（ What ），为什么这样做（ Why ），以及要特别注意的地方的，如下：
//go thru the array, note the last element is at [len-1]
for (i = 0; i<len; i++)
{
     DoSomeThing();
}
复杂的注释应该放在函数头，很多函数头的注释都是解释参数的类型等的，如果程序正文已经能够说明参数的类型 in/out 等，就不要重复！
注释也要随着程序的修改而不断更新，一个误导的（ Misleading ）注释往往比没有注释更糟糕。
另外，注释（包括所有源代码）应只用 ASCII 字符，不要用中文或其他特殊字符，它们会极大地影响程序的可移植性。
在现代编程环境中，程序编辑器可以设置各种好看的字体，我们可以使用不同的显示风格来表示程序的不同部分。

注意: 有些程序设计语言的教科书对于基本的语法有详细的注释, 那是为了教学的目的, 不宜在正式项目中也这么做。