首页 C语言编码规范

C语言编码规范

举报
开通vip

C语言编码规范附录二 C语言编码规范 编码是一种艺术,它不仅仅是为了完成某一个特定的功能而堆砌的一些英文字符,而是编程人员综合素质的体现。 程序的版式虽然不会影响程序的功能,但会影响可读性。程序的版式追求清晰、美观,是程序风格的重要构成因素。 可以把程序的编码比喻为“书法”。好的程序“书法”可让人对程序一目了然,看得兴致勃勃。差的程序“书法”如螃蟹爬行,让人看得索然无味,更令维护者烦恼有加,因此编程工程者学习程序的“书法”,是非常有必要的。 1. 版权和版本的声明 版权和版本的声明位于定义文件的开头,主要内容有: ...

C语言编码规范
附录二 C语言编码 规范 编程规范下载gsp规范下载钢格栅规范下载警徽规范下载建设厅规范下载 编码是一种艺术,它不仅仅是为了完成某一个特定的功能而堆砌的一些英文字符,而是编程人员综合素质的体现。 程序的版式虽然不会影响程序的功能,但会影响可读性。程序的版式追求清晰、美观,是程序风格的重要构成因素。 可以把程序的编码比喻为“书法”。好的程序“书法”可让人对程序一目了然,看得兴致勃勃。差的程序“书法”如螃蟹爬行,让人看得索然无味,更令维护者烦恼有加,因此编程 工程 路基工程安全技术交底工程项目施工成本控制工程量增项单年度零星工程技术标正投影法基本原理 者学习程序的“书法”,是非常有必要的。 1. 版权和版本的声明 版权和版本的声明位于定义文件的开头,主要内容有: 1. 版权信息。 2. 文件名称、标识符、摘要、功能等。 3. 版本历史信息。 4. 当前版本号、作者/修改者名字、完成日期。 例如: /* * Copyright (c) 2006, XXX大学XXX学院 * All rights reserved. * * FileName:输入创建的文件名 * Comments:输入程序的摘要 * Function:输入程序的功能 * * Version:输入当前的版本(例如:v1.0) * Author:输入作者(或修改者)名字 * CreatedDate:输入完成的日期 * * Fixed Version:输入修改后的版本(例如:v1.1) * Author:输入原作者(或修改者)名字 * CreatedDate:输入完成日期 */ 2. 版式要求 版式虽然不会影响程序的功能,但会影响可读性。程序的版式追求清晰、美观,是程序风格的重要构成因素。具体的要求如下: 1. 程序结构清晰,简单易懂,单个函数的程序行数不得超过100行。 2. 每个源程序文件,都有文件头说明。 3. 程序块要采用缩进风格编写,每次缩进一个TAB键 4. 空行起着分隔程序段落的作用。空行得体(不过多也不过少)将使程序的布局更加清晰。空行不会浪费内存,虽然打印含有空行的程序是会多消耗一些纸张,但是值得的。所以不要舍不得用空行。相对独立的程序块之间、变量说明之后必须加空行。 5. 一行代码只做一件事情,如只定一个变量,或只写一条语句。这样的代码容易阅读,并且方便于写注释。 6. 程序的分界符“{”和“}”应独占一行并且位于同一列,同时与引用它们的语句左对齐。 7. “{ }”之内的代码块在“{”右边数格处左对齐。 8. If、for、while、do等语句自占一行,执行语句不得紧跟其后。不论执行语句有多少都要加“{ }”。这样可以防止书写失误。 9. 代码行最大长度宜控制在70到80个字符以内。代码行不要过长,否则眼睛看不过来,也不便于打印。 10. 长表达式要在低优先级操作符处拆分成新行,操作符放在新行之首(以便突出操作符)。拆分出的新行要进行适当的缩进,使排版整齐,语句可读。 11. 程序结构清晰,简单易懂,单个函数的程序行数不得超过100行。 3. 注释要求 C语言的注释符为“/* ……*/”。在VC环境中,程序块的注释常采用“/*……*/”,行注释一般采用“//”。注释通常用于: (1) 版本、版权声明; (2) 函数接口说明; (3) 重要的代码行或落提示。 虽然注释有助于理解代码,但注意不可过多地使用注释。 1. 注释是对代码的“提示”,而不是文档。程序中的注释不可喧宾夺主,注释太多了会让人眼花缭乱。注释的花样要少。 2. 边写代码边注释,修改代码同时修改相应的注释,以保证注释与代码的一致性。不再有用的注释要及时删除。 3. 注释应当准确、易懂,防止注释有二义性。错误的注释不但无益反而有害。 4. 当代码比较长,特别是有多重嵌套时,应当在一些段落的结束处加注释,便于阅读。 4. 命名规则 没有一种命名规则可以让的有的程序员赞同,程序 设计 领导形象设计圆作业设计ao工艺污水处理厂设计附属工程施工组织设计清扫机器人结构设计 教科书一般都不指定命名规则。命名规则对软件产品而言并不是“成败攸关”的事,我们不要花太多精力试图发明世界上最好的命名规则,而应对制定一种令大多数项目成员满意的命名规则,并在项目中贯彻实施。 简单的比较著名的命名规则当推Microsoft公司的“匈牙利”法,该命名规则的主要思想是在“变量和函数名中加入前缀以增进人们对程序的理解”。例如所有的字符变量均以ch为前缀,若是指针变量则追加前缀p。如果一个变量由ppch开头,则表明它是指向字符指针的指针。 以下给出一些windows应用软件开发的命名规则。 1. 变量和参数用小写字母开头的单词组合而成。 2. 常量全用大写的字母,用下划线分割单词。 3. 静态变量前加前缀s_(表示static)。 4. 如果不得已需要全局变量,则使全局变量加前缀g_(表示global)。 5. 为了防止某一软件库中的一些标识符和其他软件库中的标识符冲突,可以为各种标识符加上能反映软件性质的前缀。例如三维图形标准OpenGL的所有库函数均以gl开头,所有常量(或宏定义)均以GL开头。 5. 结构化要求 1. 禁止出现两条等价的支路。 2. 禁止goto语句 3. 用if 语句来强调只执行两组语句中的一组。禁止else goto和else return。 4. 用case语句实现多路分支。 5. 避免从循环引出多个出口。 6. 函数只有一个出口。 7. 不使用条件赋值语句。 8. 避免不必要的分支。 9. 不要轻易用条件分支去替换逻辑表达式。 6. 正确性与容错要求 1. 程序首先是正确的,其次是优美。 2. 无法证明你的程序没有错误,因此在编写完一段程序后。应先回头检查。 3. 改一个错误时可能产生新的错误,因此在修改前首先考虑对其他程序的影响。 4. 所有变量在调用前必须被初始化。 5. 对所有的用户输入,必须进行合法性检查。 6. 不要比较浮点数的相等。 如:10.0*0.1 == 1.0,不可靠。
本文档为【C语言编码规范】,请使用软件OFFICE或WPS软件打开。作品中的文字与图均可以修改和编辑, 图片更改请在作品中右键图片并更换,文字修改请直接点击文字进行修改,也可以新增和删除文档中的内容。
该文档来自用户分享,如有侵权行为请发邮件ishare@vip.sina.com联系网站客服,我们会及时删除。
[版权声明] 本站所有资料为用户分享产生,若发现您的权利被侵害,请联系客服邮件isharekefu@iask.cn,我们尽快处理。
本作品所展示的图片、画像、字体、音乐的版权可能需版权方额外授权,请谨慎使用。
网站提供的党政主题相关内容(国旗、国徽、党徽..)目的在于配合国家政策宣传,仅限个人学习分享使用,禁止用于任何广告和商用目的。
下载需要: 免费 已有0 人下载
最新资料
资料动态
专题动态
is_662528
暂无简介~
格式:doc
大小:38KB
软件:Word
页数:3
分类:工学
上传时间:2012-03-11
浏览量:34