《代码风格.ppt

代码规范 rules and guidelines of Coding Style 关于代码风格问题 代码风格（Coding Style）是一种习惯 现在许多大公司都对员工书写代码制定了规范 开发大项目时由项目管理者制定代码规范 Basic rules and guidelines of Coding Style 程序版式 程序注释 命名规则 Some other rules and guidelines of Coding Style 内存管理 程序版式 程序版式——程序员的书法 比书法好学得多，基本不需要特别练习 但是坏习惯一旦养成，就像书法一样难以改变 不影响程序的功能，但影响程序的可读性 追求 清晰、整洁、美观、一目了然 容易阅读，容易测试 程序版式 不良的风格 程序版式 良好的风格 程序版式 对齐（Alignment）与缩进（indent） ——保证代码整洁、层次清晰的主要手段 “{”位置的两种风格 {和}独占一行，且位于同一列，与引用它们的语句左对齐，便于检查配对情况 位于同一层{和}之内的代码在{右边数格处左对齐，即同层次的代码在同层次的缩进层上 可以用设置为4个空格的Tab键缩进，也可以空格缩进 程序版式 现在的许多开发环境、编辑软件都支持“自动缩进” 根据用户代码的输入，智能判断应该缩进还是反缩进，替用户完成调整缩进的工作 VC中有自动整理格式功能 只要选取需要的代码，按ALT+F8就能自动整理成微软的cpp文件格式 程序版式 变量的对齐规则 数据类型 + N个TAB + 变量名 + [N个TAB ] +=+[初始化值] ; 例 char name[20]; char addr[30]; char sex = F; int age = 20; float score = 90; 程序版式 空行——分隔程序段落的作用 在每个类声明之后加空行 在每个函数定义结束之后加空行 在一个函数体内，相邻两组逻辑上密切相关的语句块之间加空行，语句块内不加空行 程序版式 代码行内的空格——增强单行清晰度 关键字之后加空格 函数名之后不加空格 赋值、算术、关系、逻辑等二元运算符前后各加一空格，但一元运算符前后一般不加空格 sum = sum + term; (向后紧跟，) , ;向前紧跟，紧跟处不留空格 , ;后留一个空格 Function(x, y, z) for (initialization; condition; update) [] . - 前后不加空格 对表达式较长的for和if语句，为了紧凑可在适当地方去掉一些空格 for (i=0; i10; i++) if ((a+bc) (b+ca) (c+ab)) 程序版式 代码行 一行只写一条语句，这样方便测试 一行只写一个变量，这样方便写注释 int width; //宽度 int height; //高度 int depth; //深度 尽可能在定义变量的同时，初始化该变量 int sum = 0; if、for、while、do等语句各占一行，执行语句无论有几条都用{和}将其包含在内，这样便于维护 if (width height) { DoSomething(); } //空行 OtherThing(); 程序版式 长行拆分 代码行不宜过长，应控制在10个单词或70-~80个字符以内 Studies show that up to ten-word text widths are optimal for eye tracking 实在太长时要在适当位置拆分，拆分出的新行要进行适当缩进 if ((veryLongVar1 = veryLongVar2) (veryLongVar3 = veryLongVar4)) { DoSomething(); } double FunctionName(double variablename1, double variablename2); for (very_longer_initialization; very_longer_condition; very_longer_update) { DoSomething(); } 程序版式 修饰符*和的位置 有争议 从语义上讲，靠近数据类型更直观，但对多个变量声明时容易引起误解 int* x, y; 提倡靠近变量名 int *x, y; 类的版式 “以数据为中心”的版式 private类型的数据写在前面，public类型的数据写在后面 关注类的内部结构 “以行为为中心”的版式