没有合适的资源?快使用搜索试试~ 我知道了~
《软件编程规范总结》是一份全面的编程指南,旨在提高代码质量、可读性和可维护性。这份规范涵盖了从基本原则到具体的语法细节,是每个程序员应当遵循的最佳实践。 基本原则强调了代码的正确性和效率,避免全局变量和过度使用`goto`语句。重用和修复旧代码能降低错误率。文件布局部分规定了头文件的处理方式,标准库和非标准库头文件的包含规则,以及类的定义和实现顺序。代码行不应超过80列,指针类型的变量定义时,星号(*)应在变量前。禁止使用tab键,使用空格进行缩进,通常为4个空格。大括号的使用也有严格规定,以保持代码结构清晰。 注释方面,源代码的注释量应达到一定比例,注释符与内容间需有空格,文件头部、函数头部、代码块结束处都应有注释,以增强可读性。注释需与代码同步更新,避免不准确的描述。 命名规则提倡使用英文单词,避免连续下划线和在标识符开头或结尾使用下划线。大小写不应仅用于区分相似标识符。相反意义的变量和函数应使用反义词命名。宏和常量全大写,变量名不超过31个字符,且不应使用单个字母(局部循环变量除外)。 此外,还有一些特定的编码约定,如操作符的使用,如一元操作符前后不加空格,多元运算符与操作数间加空格,关键字后留空格,函数名后不留空格,括号、逗号、分号的前后空格处理,以及长表达式的换行和缩进规则。 这份编程规范旨在提升代码的整洁度,减少潜在的错误,增强团队间的合作效率,以及提高代码的可读性和可维护性。程序员在编写代码时,应当严格遵守这些规范,以确保代码的质量和一致性。
资源推荐
资源详情
资源评论
软件编程规范总结(完整版)
文档资料可直接使用,可编辑,欢迎下载
软件编程规范总结
本规范的内容包括。基本原则、布局、注释、命名规则、变量常量与类型、
表达式与语句、函数与过程、可靠性、可测性、断言与错误处理等。
一、基本原则
所有的代码尽量遵循ansic标准。
编程时首先达到正确性,其次考虑效率。避免或少用全局变量。尽量避免使
用goto语句。尽可能重用、修正老的代码。尽量减少同样的错误出现的次数。
二、文件布局
1.头文件必须要避免重复包含。
2.包含标准库头文件用尖括号,包含非标准库头文件用双引号“”。
3.遵循统一的顺序书写类的定义及实现。类的定义(在定义文件中)按如下
顺序书写:
公有属性
公有函数
保护属性
保护函数
私有属性
私有函数
类的实现(在实现文件中)按如下顺序书写:
构造函数
析构函数公有函数保护函数私有函数
4.程序中一行的代码和注释不能超过80列。
5.定义指针类型的变量,___应放在变量前。
6.源程序中关系较为紧密的代码应尽可能相邻。ilengthiwidth=10;
=5;//矩形的长与宽关系较密切,放在一起。
strcaption=“test”;
7.禁止使用tab键,必须使用空格进行缩进。缩进为___个空格。
8.程序的分界符‘{’和‘}’应独占一行并且位于同一列,同时与引用它们
的语句左对齐。{}之内的代码块使用缩进规则对齐。
9.if、else、elseif、for、while、do等语句自占一行,执行语句不得紧跟
其后。不论执行语句有多少都要加{}。
if(varible1
varible1=varible2;}
10.
11.声明类的时候,public、protected、private关键字与分界符{}对齐,
这些部分的内容要进行缩进。
12.结构型的数组、多维的数组如果在定义时初始化,按照数组的矩阵结构
分行书写。
13.相关的赋值语句等号对齐。
14.在switch语句中,每一个case分支和default要用{}括起来,{}中的内容
需要缩进。
15.不同逻辑程序块之间要使用空行分隔。
16.一元操作符如“。”、“~”、“++”、“--
”、“___”、“&”(地址运算符)等前后不加空格。“[]”、“.”、“-
>”这类操作符前后不加空格。
17.多元运算符和它们的操作数之间至少需要一个空格。
18.关键字之后要留空格。(if、for、while等关键字之后应留一个空格再
跟左括号‘(’,以突出关键字。)
19.函数名之后不要留空格。(函数名后紧跟左括号‘(’,以与关键字区
别。)20.(’向后紧跟,‘)’、‘,’、‘;’向前紧跟,紧跟处不留空格。
‘,’之后要留空格。‘;’不是行结束符号时其后要留空格。
21.长表达式(超过80列)要在低优先级操作符处拆分成新行,操作符放在
新行之首(以便突出操作符)。拆分出的新行要进行适当的缩进,使排版整齐。
22.函数声明时,类型与名称不允许分行书写。
三、注释
1.一般情况下,源程序有效注释量必须在___%以上。
2.注释符与注释内容之间要用一个空格进行分隔。
3.文件头部必须进行注释,包括。.___件、.c文件、.cpp文件、.inc文件、
.def文件、编译说明文件.cfg等。
4.函数头部应进行注释,列出。函数的目的/功能、输入参数、输出参数、
返回值、访问和修改的表、修改信息等。
5.包含在{}中代码块的结束处应加注释,便于阅读。特别是多分支、多重嵌
套的条件语句或循环语句。
voidmain{
if(…){
…while(…)
}/___endofwhile(…)___/…
}/___endofif(…)___///指明是哪条语句结束}/___endofvoidmain___/
//指明函数的结束//指明该条while语句结束
6.保证代码和注释的一致性。修改代码同时修改相应的注释,不再有用的注
释要删除。
7.注释应与其描述的代码相近,对代码的注释应放在其上方或右方(对单条
语句的注释)相邻位置,不可放在下面,如放于上方则需与其上面的代码用空行
隔开。
8.全局变量要有详细的注释,包括对其功能、取值范围、访问信息及访问时
注意事项等的说明。
9.注释与所描述内容进行同样的缩排。
10.对分支语句(条件分支、循环语句等)必须编写注释。
11.尽量避免在注释中使用缩写,特别是不常用缩写。
四、命名规则
1.标识符要采用英文单词或其组合,便于记忆和阅读,切忌使用汉语拼音来
命名。严格禁止使用连续的下划线,下划线也不能出现在标识符头或结尾(预编
译开关除外)。
2.程序中不要出现仅靠大小写区分的相似的标识符。
3.用正确的反义词组命名具有互斥意义的变量或相反动作__函数等。
4.宏、常量名都要使用大写字母,用下划线‘_’分割单词。预编译开关的
定义使用下划线‘_’开始。
5.变量名长度应小于___个字符,以保持与ansic标准一致。不得取单个字符
(如i、j、k等)作为变量名,但是局部循环变量除外。
6.程序中局部变量不要与全局变量重名。
7.使用一致的前缀来区分变量的作用域。
g_
全局变量s_
模块内静态变量
空:局部变量不加范围前缀
8.使用一致的小写类型指示符作为前缀来区分变量的类型。说明:常用变量
类型前缀列表如下:
i
int
f
floatd:doublec
charuc
unsignedchar或bytel:longp
pointerb
boolh:handlew
unsignedshort或worddw:dword或unsignedlonga
数组,arrayoftypestr
字符串t:结构类型
9.完整的变量名应由前缀+变量名主体组成,变量名的主体应当使用“名词
”或者“形容词+名词”,且首字母必须大写。
floatg_fvalue;
剩余35页未读,继续阅读
资源评论
xinkai1688
- 粉丝: 381
- 资源: 8万+
上传资源 快速赚钱
- 我的内容管理 展开
- 我的资源 快来上传第一个资源
- 我的收益 登录查看自己的收益
- 我的积分 登录查看自己的积分
- 我的C币 登录后查看C币余额
- 我的收藏
- 我的下载
- 下载帮助
最新资源
资源上传下载、课程学习等过程中有任何疑问或建议,欢迎提出宝贵意见哦~我们会及时处理!
点击此处反馈
安全验证
文档复制为VIP权益,开通VIP直接复制
信息提交成功