组织与策略问题讲述.ppt

* 编程规范—第一讲组织与策略问题 软件工程系 本小节主要阐述的是程序编程开发的基本问题，这些问题大多与代码本身并没有直接关系，它们讨论的是编写规范代码所必须的工具与技术。 不要拘泥于小节 在高警告级别处干净利落地进行编译 使用自动构建系统 使用版本控制系统 做代码审查 1.不要拘泥小节 不要强制施加个人喜好或者过时的做法 应该在每个源文件乃至每个项目中都使用一致的编程格式 不要规定缩进多少，应该规定要用缩进来体现代码的结构； 不要强制行的具体长度，应该保证代码行的长度有利于阅读； 不要在命名方面规定过多，应该规定的是使用一致的命名规范； 不要规定注释风格，应该编写有用的注释。 W文件结构 文件 每个C++程序通常可以分为两个文件： 一个文件用于保存程序的声明，称为头文件（“.h”）； 一个文件用于保存程序的实现，称为定义文件(“.cpp”). W文件结构 文件 头文件由三部分组成 头文件开头出的版权和版本声明； 预处理块； 函数和类结构声明等。 为了防止头文件被重复引用，应当用ifndef/define/endif结构产生预处理块 头文件（graphics.h ）中只存放“声明” 而不存放“定义”。 W文件结构 文件 定义文件由三部分组成 定义文件开头出的版权和版本声明 对一些头文件的定义 程序的实现体 假设定义文件的名称为graphics.cpp。 程序版式 文件 空行：在每个类声明之后，每个函数定义结束后都要加空行。 每行代码只做一件事，如只定义一个变量，或只写一条语句。这样的代码容易阅读，并且方便注释。 If、for、while、do等语句自占一行，执行语句不得紧跟其后。不论执行语句有多少都要加{}。 尽可能在定义变量的同时初始化该变量。Int sum=0; 修饰符的位置应该紧靠变量：int *x,y; 命名规则 文件 命名两个基本原则： 含义清晰，不易混淆； 不和其他模块、系统API的命名空间相冲突即可。 标识符应当直观且可以拼读，最好采用英文单词或其组合，便于记忆和阅读。不要用汉语拼音。标识符长度应当符合“min-lengthmax-information” 命名规则 文件 命名规则尽量与所采用的操作系统或开发工具的风格保持一致。Windows应用程序通常采用大小写混排（AddChild）。Unix应用程序标识符次用小写加下划线（add_child） 程序中不要出现仅靠大小写区分的相似标识符。 Int X,x; void foo(int x); void FOO(float x); 局部变量与全局变量不要完全相同。尽管作用域不同也很容易出现语法错误。 变量名尽量使用“名词”或者“形容词+名词”;全局函数名字应当使用“动词”或“动词+名词”，类中的成员函数可以只用“动词”； Float value;Float oldvalue; DrawBox(); box-Draw(); 命名规则 文件 Windows 应用程序命名规则: 类名和函数名用大写字母开头的单词组合而成 Class Node;Class leafNode;//类名 Void Draw(void);void SetValue(int value);//函数名 变量和参数用小写字母开头的单词组合而成。 BOOL flag; int drawMode; 常量全用大写字母、用下划线分割单词。 Const int MAX = 100; Const int MAX-LENGTH = 100; 静态变量加前缀s_（表示static） 注释 文件 注释常用于 版本、版权声明； 函数借口说明； 重要的代码行或段落提示。 注释是对代码的提示，不宜太多，如果代码本身清楚，则不必注释。 边写代码边注释，修改代码同时修改注释，保持注释与代码的一致。 注释中避免出现缩写，位置与被描述代码相邻，可以放在代码上方或右方，不可放在下方。 当代码过长，特别出现多重嵌套时，应当在一些段略的结束处加注释，便于阅读。 第1条：在高警告级别干净利落地进行编译 高度重视警告：使用编译器的最高警告级别。理解所有警告通过修改代码而不是降低警告级别来排除警告 编译器对某个构造发出警告，一般表明代码中存在潜在问题。 成功的构建应该是无声无息的，没有警告。排除警告的正确做法就是：把它弄清楚，然后改写代码以排除警告，并使代码阅读者和编译器都能更加清楚，代码是按编写者的意图执行的。 2.在高警告级别干净利落地进行编译 未使用参数：不提供该参数名称即可 未使用的变量：插入一个该变量的表达式即可。这算是一个惯用法了，会比较多的用到。 变量未初始化：初始化。需要通过一个过程来初始化的例外，即形如：obj; init_obj(obj); 某些