编码规范-东软-内部资料.doc_第1页
编码规范-东软-内部资料.doc_第2页
编码规范-东软-内部资料.doc_第3页
编码规范-东软-内部资料.doc_第4页
编码规范-东软-内部资料.doc_第5页
已阅读5页,还剩3页未读, 继续免费阅读

下载本文档

版权说明:本文档由用户提供并上传,收益归属内容提供方,若内容存在侵权,请进行举报或认领

文档简介

文件名称 版本:x.x.x-x.x.x 第1页工程的目录结构一个工程应该划分为若干个目录,目录应该是模块划分的体现。如:Project ModuleName1ModuleName2 ModuleNamenIncludeBinLib其中include目录下应该放置公共的头文件。Bin目录下放执行文件Lib目录下*.lib文件n 目录名称要有意义文件文件的结构n 文件的种类有两种:源文件(*.c)和头文件(*.h)。n 源文件中一般应该包括的内容:本文件需要包含的头文件;只在本文件内部使用的(对外部隐藏的)类型;只在本文件内部使用的(对外部隐藏的)常量;只在本文件内部使用的(对外部隐藏的)宏定义;只在本文件内部使用的函数原型说明;只在本文件内部使用的(对外部隐藏的)变量的声明;函数的代码实现。n 头文件中应该包含的内容提供给外部参照的类型;提供给外部参照宏定义;提供给外部参照(全局)函数原型说明;n 文件划分的准则高内聚;低耦合;文件的命名及文件的长度n 文件名只能由小写字母、数字和_组合而成。n 使用英语命名,尽量选用可以发音和有意义的名字。n 一个文件的长度不要超过1000行代码。源文件n 一般说来,源文件的整体构成包括以下内容(有时可能不存在某些部分)。具体情况请参见源文件模板。源文件的注释框包含文件部分宏定义部分类型定义部分结构体定义部分全局变量定义部分文件static变量定义部分函数原型声明调试开关定义部分函数定义部分头文件n 一般说来,头文件的整体构成包括以下内容(有时可能不存在某些部分)。具体情况请参见头文件模板。头文件的注释框包含文件部分宏定义部分类型定义部分结构体/类定义部分函数原型声明n 头文件应采用#ifndef/#define/#endif的方式来防止多次被包含,其中使用的宏名为:“_”+“文件名”+“_”+“扩展名”,文件名与扩展名均为大写。对n 头文件的包含应该采用相对路径,而不采用绝对路径。n #include包含的文件名称应由小写字母、数字和_组合而成。n 为了减少执行程序的大小,不应包含不需要的头文件。n 头文件中不要定义变量。大连东软信息学院沈阳培训中心程序格式排版、注释排版分行n 较长的语句、表达式等要分成多行书写,一行程序不要超过81列; n 不允许把多个短语句写在一行中,即一行只写一条语句。n 循环、判断等语句中若有较长的表达式或语句,则要进行适应的划分;划分的原则:整齐、美观、符合其他编码规范。n 若函数的参数较长,则要进行适当的划分。划分的原则:整齐、美观、符合其他编码规范。n 在两个函数定义之间必须使用空行分开。n 在函数定义中,用空行将代码按逻辑片断划分。例如两个并列的判断语句之间就可以用空行来区分;变量的定义、变量的初始化以及真正的处理语句之间就可以用空行来区分。n 意义不一致的宏定义之间、全局变量之间、函数声明之间需要添加空行。n 如果函数参数不只有一个,则每个参数的定义各占一行,每行前有一个制表符的缩进。n 最后一个参数的定义后要紧跟右括号。n 定义函数体的左右大括号要各自独占一行。【可检查: 04-04-01】空格n 单目操作符后不要加空格。n 单目操作符前不要加空格。n 赋值符号前后要有一个空格。位逻辑运算符号后的ASCII码应该有一个空格。 n 在条件表达式与括号间应该有一个空格。n 在问号表达式(?)前后应该有一个空格。n 在二元逻辑操作符前后应该有一个空格。n 在比较操作符号前后应该有一个空格。n 在“.”、“-”前后不应该有空格。n 在数组名与“”之间不应该有空格。n “,”之后应该有空格。n “;”之后应该有空格。n “sizeof”与“(”之间不应该有空格;“(”与类型之间不应该有空格。缩进n 代码缩进要使用制表符,而不是直接使用空格。n 对嵌套语句使用一个制表符-Tab(4个字符)的缩进。n 尽可能保证缩进嵌套的层数不超过四层。注释n 边写代码边注释,修改代码同时修改相应的注释,以保证注释与代码的一致性。n 注释写在说明代码的上面。n 注释的目的是解释代码的目的、功能和采用的方法,提供代码以外的信息,帮助读者理解代码,防止没必要的重复注释信息。n 注释与前面的执行语句之间空一行。n 源文件的开头要有注释,但每个业务/项目由于客户的要求不同而有不同的注释格式,这里对注释格式不作统一要求。n 注释不要有嵌套。n 应对不易理解的分枝条件表达式加注释。n 不易理解的循环, 应说明出口条件。函数函数命名n 函数名只能由大小写字母与数字构成。n 函数名中除前缀外的各个单词首字母要大写。函数说明n 函数必须都有函数说明。说明中必须包含如下内容:1. 名称(Function Name):函数的名称。2. 描述(Description):函数功能的简单描述。3. 作成日期(Created):格式为YY/MM/DD的日期,如03/09/28。4. 参数(Parameter):函数参数的说明。a. 参数说明的顺序依次为参数名称、参数类型、输入参数还是输出参数。b. 如果函数没有任何参数,本项填写“VOID”。5. 返回值类型(Return Code):函数返回值的类型。a. 如果函数不需要返回值,本项填写“VOID”。6. 作者(Author):函数的作者。函数定义n 注意控制参数的数量,一般来说不要超过7个,当参数过多时,应该考虑将参数定义为一个结构体,并且将结构体指针作为参数。n 函数的大小不要过长,一般定为60行以内(除去注释,空行,变量定义,调试开关等)。n 一个函数仅完成一件功能。n 防止将函数的参数作为工作变量。n 编写可重入函数时,若使用全局变量,则应通过信号量保护。对于可能在中断处理程序中访问的全局变量,应该用关中断的方式进行保护。函数声明n 一定要显示声明函数的返回值类型。n 如果函数不需要返回值,要声明为void类型。n 如果函数没有参数,参数处要书写void。n 函数的声明要与函数定义一致(包括函数的类型及参数的类型、个数、顺序)。函数调用n 回避函数的递归调用。n 调用没有参数的函数时、不要忘了加括弧“( )”。n 使用从pointer型函数返回値的时候,要确认它不是NULL之后再使用。n 使用标准Library的函数的时候、在调用之前要确认,成为参数的値是否是作为其函数的参数能够取得的范围内的値。n 函数调用传递的参数(类型、个数、顺序要与函数定义一致)。变量变量命名n 变量的构成要素:(类型)+(标识符)实例: 如iNo,其中i是类型符,表示返回值是整型。下面对类型缩写进行说明:20每个元素为指向unsigned int型指针的数组的类型为apui; 21每个元素为指向long型指针的数组的类型为apl; 22每个元素为指向unsigned long型指针的数组的类型为apul; 23每个元素为指向struct型指针的数组的类型为apst; 24每个元素为指向union型指针的数组的类型为aput; 25每个元素为指向enum型指针的数组的类型为apen; 26每个元素为指向class型指针的数组的类型为apcl; 27每个元素为指向void型指针的数组的类型为apv; 28每个元素为指向wide char型指针的数组的类型为apwc; 29每个元素为指向function型指针的数组的类型为apfn; 1每个元素为short型的数组的类型为as; 2每个元素为unsigned short型的数组的类型为aus; 3每个元素为bool型的数组的类型为ab; 4每个元素为char型的数组的类型为ac; 5每个元素为unsigned char型的数组的类型为auc; 6每个元素为int型的数组的类型为ai; 7每个元素为unsigned int型的数组的类型为aui; 8每个元素为long型的数组的类型为al;9每个元素为unsigned long型的数组的类型为aul; 10每个元素为struct型的数组的类型为ast; 11每个元素为union型的数组的类型为aut; 12每个元素为enum型的数组的类型为aen; 13每个元素为class型的数组的类型为acl; 14每个元素为指向short型指针的数组的类型为aps; 15每个元素为指向unsigned short型指针的数组的类型为apus; 16每个元素为指向bool型指针的数组的类型为apb; 17每个元素为指向char型指针的数组的类型为apc;18每个元素为指向unsigned char型指针的数组的类型为apuc; 19每个元素为指向int型指针的数组的类型为api; 30每个元素为指向void型的数组的类型为av; 31每个元素为指向wide char型的数组的类型为awc; 32short的类型为s; 33unsigned short的类型为us; 34bool的类型为b;35char的类型为c; 36unsigned char的类型为uc; 37wide char的类型为wc;38long的类型为l; 39unsigned long的类型为ul; 40struct的类型为st;41union的类型为ut; 42enum的类型为en;43class的类型为cl; 44short型指针的类型为ps;45unsigned short型指针的类型为pus;46bool型指针的类型为pb; 47char型指针的类型为pc; 48unsigned char型指针的类型为puc; 49int型指针的类型为pi;50unsigned int型指针的类型为pui;51long型指针的类型为pl; 52unsigned long型指针的类型为pul; 53struct型指针的类型为pst; 54union型指针的类型为put;55enum型指针的类型为pen; 56class型指针的类型为pcl; 57function型指针的类型为pfn; 58元素为short型数组指针的类型为pas; 59元素为unsigned short型数组指针的类型为paus; 60元素为bool型数组指针的类型为pab; 61元素为char型数组指针的类型为pac; 62元素为unsigned char型数组指针的类型为pauc; 63元素为int型数组指针的类型为pai; 64元素为unsigned int型数组指针的类型为paui; 65元素为long型数组指针的类型为pal; 66元素为unsigned long型数组指针的类型为paul; 67元素为struct型数组指针的类型为past; 68元素为union型数组指针的类型为paut; 69元素为enum型数组指针的类型为paen; 70元素为class型数组指针的类型为pacl; 71void型的类型为v变量的类型转换n 不提倡变量间的类型转换。n 如需要类型转换,请采用显形方式进行。n 建议不要直接比较BOOL类型变量。n 不要将有符号数强制转化为无符号数。n 不要将浮点型指针强制转化为整型指针。变量定义与初始化n 关于变量的定义:在C语言中,变量应该在函数开头定义; n 原则上在定义变量的

温馨提示

  • 1. 本站所有资源如无特殊说明,都需要本地电脑安装OFFICE2007和PDF阅读器。图纸软件为CAD,CAXA,PROE,UG,SolidWorks等.压缩文件请下载最新的WinRAR软件解压。
  • 2. 本站的文档不包含任何第三方提供的附件图纸等,如果需要附件,请联系上传者。文件的所有权益归上传用户所有。
  • 3. 本站RAR压缩包中若带图纸,网页内容里面会有图纸预览,若没有图纸预览就没有图纸。
  • 4. 未经权益所有人同意不得将文件中的内容挪作商业或盈利用途。
  • 5. 人人文库网仅提供信息存储空间,仅对用户上传内容的表现方式做保护处理,对用户上传分享的文档内容本身不做任何修改或编辑,并不能对任何下载内容负责。
  • 6. 下载文件中如有侵权或不适当内容,请与我们联系,我们立即纠正。
  • 7. 本站不保证下载资源的准确性、安全性和完整性, 同时也不承担用户因使用这些下载资源对自己和他人造成任何形式的伤害或损失。

评论

0/150

提交评论