1 / 9
文档名称:

软件编程规范总结.docx

格式:docx   大小:28KB   页数:9页
下载后只包含 1 个 DOCX 格式的文档,没有任何的图纸或源代码,查看文件列表

如果您已付费下载过本站文档,您可以点这里二次下载

分享

预览

软件编程规范总结.docx

上传人:iris028 2019/4/18 文件大小:28 KB

下载得到文件列表

软件编程规范总结.docx

文档介绍

文档介绍:软件编程规范总结本规范的内容包括:基本原则、布局、注释、命名规则、变量常量与类型、表达式与语句、函数与过程、可靠性、可测性、断言与错误处理等。基本原则保持代码的简明清晰,避免过分的编程技巧。所有的代码尽量遵循ANSIC标准。编程时首先达到正确性,其次考虑效率。避免或少用全局变量。尽量避免使用GOTO语句。尽可能重用、修正老的代码。尽量减少同样的错误出现的次数。文件布局头文件必须要避免重复包含。包含标准库头文件用尖括号<>,包含非标准库头文件用双引号“”。遵循统一的顺序书写类的定义及实现。类的定义(在定义文件中)按如下顺序书写:公有属性公有函数保护属性保护函数私有属性私有函数类的实现(在实现文件中)按如下顺序书写:构造函数析构函数公有函数保护函数私有函数程序中一行的代码和注释不能超过80列。定义指针类型的变量,*应放在变量前。源程序中关系较为紧密的代码应尽可能相邻。iLength =10;iWidth =5;//矩形的长与宽关系较密切,放在一起。StrCaption =“Test”;禁止使用TAB键,必须使用空格进行缩进。缩进为4个空格。程序的分界符‘{’和‘}’应独占一行并且位于同一列,同时与引用它们的语句左对齐。{}之内的代码块使用缩进规则对齐。if、else、elseif、for、while、do等语句自占一行,执行语句不得紧跟其后。不论执行语句有多少都要加{}。if(varible1<varible2){varible1=varible2;}声明类的时候,public、protected、private关键字与分界符{}对齐,这些部分的内容要进行缩进。结构型的数组、多维的数组如果在定义时初始化,按照数组的矩阵结构分行书写。相关的赋值语句等号对齐。在switch语句中,每一个case分支和default要用{}括起来,{}中的内容需要缩进。不同逻辑程序块之间要使用空行分隔。一元操作符如“!”、“~”、“++”、“--”、“*”、“&”(地址运算符)等前后不加空格。“[]”、“.”、“->”这类操作符前后不加空格。多元运算符和它们的操作数之间至少需要一个空格。关键字之后要留空格。(if、for、while等关键字之后应留一个空格再跟左括号‘(’,以突出关键字。)函数名之后不要留空格。(函数名后紧跟左括号‘(’,以与关键字区别。)(’向后紧跟,‘)’、‘,’、‘;’向前紧跟,紧跟处不留空格。‘,’之后要留空格。‘;’不是行结束符号时其后要留空格。长表达式(超过80列)要在低优先级操作符处拆分成新行,操作符放在新行之首(以便突出操作符)。拆分出的新行要进行适当的缩进,使排版整齐。函数声明时,类型与名称不允许分行书写。注释一般情况下,源程序有效注释量必须在20%以上。注释符与注释内容之间要用一个空格进行分隔。文件头部必须进行注释,包括:.h文件、.c文件、.cpp文件、.inc文件、.def文件、。函数头部应进行注释,列出:函数的目的/功能、输入参数、输出参数、返回值、访问和修改的表、修改信息等。包含在{}中代码块的结束处应加注释,便于阅读。特别是多分支、多重嵌套的条件语句或循环语句。voidMain(){if(…){… while(…){…}/*endofwhile(…)*/ //指明该条while语句结束…}/*endofif(