代码规范试用稿.ppt

《代码规范试用稿.ppt》由会员分享，可在线阅读，更多相关《代码规范试用稿.ppt（57页珍藏版）》请在三一办公上搜索。

1、代码规范试用稿,哈尔滨工业大学计算机科学与技术学院苏小红,关于代码风格问题,代码风格（Coding Style）是一种习惯现在许多大公司都对员工书写代码制定了规范开发大项目时由项目管理者制定代码规范程序风格的重要构成因素程序版式命名规则函数设计原则其他表达式规则与零比较常量规则动态数组内存管理,程序版式,程序版式程序员的书法比书法好学得多，基本不需要特别练习但是坏习惯一旦养成，就像书法一样难以改变不影响程序的功能，但影响程序的可读性追求清晰、整洁、美观、一目了然容易阅读，容易测试,程序版式,不良的风格,int isprime(int n)int k,i;if(n=1)return 0;k=sq

2、rt(double)n);for(i=2;i=k;i+)if(n%i=0)return 0;return 1;,#include#include main()int i;for(i=2;i100;i+)if(isprime(i)printf(%dt,i);,程序版式,良好的风格,int isprime(int n)int k,i;if(n=1)return 0;k=(int)sqrt(double)n);for(i=2;i=k;i+)if(n%i=0)return 0;return 1;,#include#include main()int i;for(i=2;i100;i+)if(ispri

3、me(i)printf(%dt,i);,程序版式,对齐（Alignment）与缩进（indent）保证代码整洁、层次清晰的主要手段“”位置的两种风格和独占一行，且位于同一列，与引用它们的语句左对齐，便于检查配对情况位于同一层和之内的代码在右边数格处左对齐，即同层次的代码在同层次的缩进层上一般用设置为4个空格的Tab键缩进，不用空格缩进,建议的风格,不建议的风格,程序版式,现在的许多开发环境、编辑软件都支持“自动缩进”根据用户代码的输入，智能判断应该缩进还是反缩进，替用户完成调整缩进的工作VC中有自动整理格式功能只要选取需要的代码，按ALT+F8就能自动整理成微软的cpp文件格式,程序版式,变量

4、的对齐规则数据类型+N个TAB+变量名+N个TAB+=+初始化值;例char name20;char addr30;char sex=F;int age=20;float score=90;,程序版式,空行分隔程序段落的作用在每个类声明之后加空行在每个函数定义结束之后加空行在一个函数体内，相邻两组逻辑上密切相关的语句块之间加空行，语句块内不加空行,程序版式,代码行内的空格增强单行清晰度关键字之后加空格函数名之后不加空格赋值、算术、关系、逻辑等二元运算符前后各加一空格，但一元运算符前后一般不加空格sum=sum+term;(向后紧跟，),;向前紧跟，紧跟处不留空格,;后留一个空格Function

5、(x,y,z)for(initialization;condition;update).-前后不加空格对表达式较长的for和if语句，为了紧凑可在适当地方去掉一些空格for(i=0;ic)&(b+ca)&(c+ab),程序版式,程序版式,代码行一行只写一条语句，这样方便测试一行只写一个变量，这样方便写注释int width;/宽度int height;/高度int depth;/深度尽可能在定义变量的同时，初始化该变量int sum=0;if、for、while、do等语句各占一行，执行语句无论有几条都用和将其包含在内，这样便于维护if(width height)DoSomething();/

6、空行OtherThing();,程序版式,程序版式,长行拆分代码行不宜过长，应控制在70-80个字符以内实在太长时要在适当位置拆分，拆分出的新行要进行适当缩进if(veryLongVar1=veryLongVar2),程序版式,修饰符*和,注释规范,注释（Comments）的重要性写注释给谁看？在哪些地方写注释？怎样写注释？注释的风格写注释时的注意事项可灵活运用的一些规则,注释规范,注释的重要性注释对于程序犹如眼睛对于人的重要性一样没有注释的程序对于读者好比眼前一团漆黑，跟拿到一个可执行程序别无二致不规范的注释和好几千度的近似眼没什么区别代码本身体现不出价值开发程序的思维才能使其变得有价值这种

7、思维的具体体现就是在于注释和规范的代码本身,注释规范,写注释给谁看？给自己看，使自己的设计思路得以连贯给继任者看，使其能够接替自己的工作,注释规范,写注释的最重要的功效在于传承要站在继任者的角度写简单明了、准确易懂、防止二义性让继任者可以轻松阅读、复用、修改自己的代码让继任者轻松辨别出哪些使自己写的，哪些是别人写的,注释规范,不好的注释i=i+1;/i加1return-1;/返回-1free(p);/释放p所指的内存fclose(fin);/关闭文件/*/*功能描述：本函数用于实现xxx功能，目的是：*/*入口参数：参数p，表示指向结构体的指针*/*出口参数：参数xx，表示*/*返回值：返回x

8、x值，当返回xx值时，表示*/*/,注释规范,不好的注释不但白写，还扰乱了读者的视线/*以二进制只读方式打开文件并判断打开是否成功*/if(fin=fopen(cat.pic,rb)=NULL)puts(打开文件cat.pic失败);/*如果打开失败，则显示错误信息*/return-1;/*返回-1*/*从图像的第1行到第400行循环*/for(i=0;i400;i+)/*从图像的第1列到第400列循环*/for(j=0;j400;j+)/*按照公式Y=0.299*R+0.587*G+0.114*B计算灰度值*/y=(299*r+587*g+114*b)/1000;fclose(fin);/*

9、关闭文件*/,注释规范,好的注释（尤其是算法注释）是对设计思想的精确表述和清晰展现，能揭示代码背后隐藏的重要信息/*打开输入文件后判断文件长度是否符合格式要求*/if(fin=fopen(cat.pic,rb)=NULL)puts(打开文件cat.pic失败);return-1;/*下面是图像转换的算法实现。彩色图像到灰度图像的转换主要利用RGB颜色空间到*YUV颜色空间的变换公式来取得灰度值，公式为Y=0.299*R+0.587*G+0.114*B*/for(i=0;i400;i+)for(j=0;j400;j+)y=(299*r+587*g+114*b)/1000;fclose(fin);

10、,注释规范,在哪些地方写注释？在重要的文件首部文件名+功能说明+作者+版本+版权声明+日期在用户自定义函数前对函数接口进行说明函数功能+入口参数+出口参数+返回值（包括出错处理）在一些重要的语句块上方对代码的功能、原理进行解释说明在一些重要的语句行右方定义一些非通用的变量函数调用较长的、多重嵌套的语句块结束处在修改的代码行旁边加注释,注释规范,函数的注释风格C风格/*/*功能描述：本函数用于实现xxx功能，目的是：*/*入口参数：参数xx，表示*/*出口参数：参数xx，表示*/*返回值：返回xx值，当返回xx值时，表示*/*/*功能描述：本函数用于实现xxx功能，目的是：入口参数：参数xx，表

11、示 出口参数：参数xx，表示 返回值：返回xx值，当返回xx值时，表示*/C+风格/功能描述：本函数用于实现xxx功能，目的是：/入口参数：参数xx，表示/出口参数：参数xx，表示/返回值：返回xx值，当返回xx值时，表示/,注释规范,一块语句的注释风格/*C风格*/C风格/*/*下面代码是用来接收网络数据，其原理为*/*/*/Visual C+风格/,注释规范,一行语句的注释风格/*C风格*/Visual C+风格i=j+1;/代码行右方的注释/代码行之上的注释i=j+1;例子ResetSrollInfo(g_hwndThumb);/初始化滚动条位置for循环while循环 if()/if结

12、束/while结束/for结束,注释规范,写注释时的注意事项注释不是白话文翻译，不要鹦鹉学舌注释不是教科书，不要把别人当成初学者注释不是标准库函数参考手册注释不是越多越好，不好的注释等于垃圾不写做了什么，写想做什么边写代码边注释修改代码同时修改注释,注释规范,可灵活运用的一些规则注释可长可短，但应画龙点睛，重点加在语义转折处简单的函数可以用一句话简单说明/两数交换void Swap(int*x,int*y)内部使用的函数可以简单注释，供别人使用的函数必须严格注释，特别是入口参数和出口参数,Readme的书写内容,主要用来记录日期、创建者、内容等每次重大功能的添加、修改具体格式：日期TAB创建者

13、TAB内容日期:2003.1.21创建者:XXX内容:实例工程日期TAB修改的文件名TAB修改的功能对修改后的功能和原理的说明日期TAB修改的文件名TAB修改的功能对修改后的功能和原理的说明,类的版式,“以数据为中心”的版式private类型的数据写在前面，public类型的数据写在后面关注类的内部结构“以行为为中心”的版式public类型的数据写在前面，private类型的数据写在后面关注的是类应该提供什么样的接口（或服务）提倡后者因为用户最关心的是接口,标识符命名规则,按照执行级别分为：共性规则必须执行简化规则建议采用可选规则灵活运用,标识符命名的共性规则,直观可以拼读，见名知意，不必解码

14、最好采用英文单词或其组合，切忌用汉语拼音尽量避免出现数字编号不要出现仅靠大小写区分的相似的标识符不要出现名字完全相同的局部变量和全局变量用正确的反义词组命名具有互斥意义的变量或相反动作的函数int minValue;int maxValue;int GetValue();int SetValue();,标识符命名的共性规则,尽量与所采用的操作系统或开发工具的风格保持一致在Linux/Unix平台习惯用“小写加下划线”function_name variable_NameWindows风格大小写混排的单词组合而成 FunctionName variableName,Windows应用程序命名规则

15、,Microsoft公司的Hungarian Notation主要思想在变量和函数名前加上前缀，用于标识变量的数据类型限定范围的前缀+数据类型前缀+有意义的英文单词限定范围的前缀静态变量前加前缀s_，表示static全局变量前加前缀g_，表示global类内的成员函数m_默认情况为局部变量数据类型前缀ch 字符变量前缀i 整型变量前缀f 实型变量前缀p 指针变量前缀,Windows应用程序命名规则,缺点烦琐例如int i,j,k;float x,y,z;若采用匈牙利命名规则，则应写成int iI,iJ,ik;/前缀i表示int类型float fX,fY,fZ;/前缀f表示float类型,简化的

16、Windows应用程序命名规则,变量名形式小写字母开头“名词”或者“形容词+名词”如oldValue,newValue等函数名形式大写字母开头“动词”或者“动词+名词”（动宾词组）如GetValue(),SetValue()等 宏和const常量全用大写字母，并用下划线分割单词#define ARRAY_LEN 10const int MAX_LEN=100;,灵活运用的命名规则,限定范围的前缀与数据类型前缀可要可不要无特殊意义的循环变量可以直接定义成i,j,k等单字母变量,表达式规则,尽量简单，不要太复杂不要多用途a=i+i+i+;printf(%d,%d,%d,i+,i+,i+);不要与数

17、学表达式混淆if(abc)不表示 if(ab)&(bc),无需背诵的规则,运算符优先级先算括号用括号确定表达式的操作顺序，避免使用默认的优先级库函数用法会查联机帮助、手册最重要,需要考虑移植性的问题,不同平台，不同编译器，可能会迥然不同凡是需要字节数的地方，一律用sizeof获得,与零比较的规则,布尔变量与零比较不应写成if(flag=0)if(flag!=0)应写成if(flag)/表示flag为真if(!flag)/表示flag为假,与零比较的规则,整型变量与零比较不应写成if(value)/容易误解为布尔变量if(!value)应写成if(value=0)if(value!=0)写成如下

18、形式能防止=误写为=if(0=value)if(0!=value),与零比较的规则,实型变量与零比较不应写成if(x=0.0)/float和double变量都有精度限制应写成if(x=-EPS)&(x=EPS)if(fabs(x)=EPS),与零比较的规则,指针变量与零比较不应写成if(p=0)/容易误解为整型变量if(p!=0)if(p)/容易误解为布尔变量if(!p)应写成if(p=NULL)/强调p是指针变量if(p!=NULL),常量规则,尽量使用含义直观的常量来表示多次出现的数字或者字符串#define PI 3.14159const float PI=3.14159;C+中用con

19、st常量完全取代宏常量需要对外公开的常量集中放在一个公共的头文件中，不需要对外公开的常量放在定义文件的头部,常量规则,怎样建立在类中恒定，且仅在类中有效的常量？#define定义的宏常量是全局的const数据成员可以吗？,常量规则,class A const int SIZE=100;/不能在类声明中初始化const数据成员 int arraySIZE;/类的对象未被创建时，SIZE值未知;const数据成员只能在类构造函数的初始化表中进行class A A(int size);/构造函数 const int SIZE;A:A(int size):SIZE(size)A a(100);/对象a

20、的SIZE值为100A b(200);/对象b的SIZE值为200,常量规则,怎样建立在整个类中都恒定的常量呢？const数据成员只在某个对象生存期内是常量，而对类而言是可变的因为类可以创建多个对象不同对象的const数据成员值不同 不能指望const数据成员了,常量规则,怎样建立在整个类中都恒定的常量呢？应该用类中的枚举常量来实现 class A enum SIZE1=100,SIZE2=200;/枚举常量 int arrayASIZE1;int arrayBSIZE2;缺点：隐含数据类型是整数，其最大值有限，且不能表示浮点数,动态数组,一维动态数组 int*p=NULL;p=(int*)m

21、alloc(n*sizeof(int);pi/像使用一维数组一样使用二维动态数组int*p=NULL;p=(int*)calloc(m*n,sizeof(int);pi*n+j);/像使用一维数组一样使用,函数设计原则,函数的功能要单一，不要设计多用途的函数 函数的规模要小，尽量控制在50行代码以内1986年IBM在OS/360的研究结果：大多数有错误的函数都大于500行1991年对148,000行代码的研究表明：小于143行的函数比更长的函数更容易维护,函数设计原则,参数的规则参数要书写完整，不要省略参数类型和参数名没有参数时，用void填充参数个数尽量控制在5个以内参数名要恰当，顺序要合理

22、void MyStrcpy(char*str1,char*str2);void MyStrcpy(char*dstStr,char*srcStr);如果参数是指针，且仅作输入用，则应在类型前加constvoid MyStrcpy(char*dstStr,const char*srcStr);,函数设计原则,返回值的规则不要省略返回值的类型，可声明为void确保返回值与声明的类型一致，不要依赖自动类型转换不能返回指向栈内存的指针犯了释放内存以后还继续使用的错误,函数设计原则,函数内部实现的规则在函数的入口处，使用断言assert检查参数的合法性尽量少用全局变量，确保函数的单入口和单出口，不得不用时，要严格控制对它的改写，例如，几个有关联的函数需要使用全局变量时全局变量应和访问全局变量的函数放在单独的一个文件中，与其它文件分别编译并且将该全局变量声明为static（静态全局变量）尽量少用静态局部变量，以避免使函数具有“记忆”功能,成对编码,写函数体时先写上面的大括号然后马上就写下面的大括号最后再插入函数体内的代码动态申请内存时先分配一块内存然后马上就写释放这块内存的代码最后再在中间插入你要用这块内存做什么的代码所有变量要集中申请在函数的首部或块的首部按以上方法编程不仅能保证快速正确，而且不必等代码全部写完就可以调试,谢谢！,