




版权说明:本文档由用户提供并上传,收益归属内容提供方,若内容存在侵权,请进行举报或认领
文档简介
1、c语言程序设计,教学专业:软件技术专业,前言说明的重要性。今天,人们越来越意识到软件设计更多的是一门工程而不是一门个人艺术。因为大规模产品的开发通常是由许多人来协调的,如果编程标准不统一,最终程序的可读性就会很差,这不仅会给代码的理解带来障碍,还会增加维护阶段的工作量。同时,非标准代码隐含错误的可能性相对较大。贝尔实验室(BELL Laboratories)的研究数据显示,约18%的软件错误发生在概要设计阶段,约15%发生在详细设计阶段,编码阶段产生的错误比例接近50%;分析表明,语法错误约占编码阶段错误的20%,而未严格检查软件逻辑导致的错误、功能(模块)之间的接口错误以及优化维护阶段错误代
2、码修改导致的错误占一半以上。因此,为了提高软件质量,有必要降低编码阶段的错误率。如何有效减少编码阶段的错误?贝尔实验室的研究人员制定了详细的软件编程规范,并培训了每个程序员。最终结果将编码阶段的错误减少到10%左右,也降低了程序的测试成本,效果显著。本文从代码可维护性(可读性、可理解性和可修改性)、代码逻辑和效率、功能(模块)接口和可测试性四个方面阐述了软件编程规范。它分为两部分,第一部分是命名规范,第二部分是编程规范。本规范是天马公司的强制性项目。前言规范的重要性,我们制定了一个编程风格,希望达到以下目标:可移植性、一致性、整洁性、易维护性、易理解性和简洁性。在团队合作的大型项目中,这种风格
3、应该始终贯穿始终。采用通用的代码编写风格可以减少代码维护的工作量和成本;这种通用的代码风格也可以避免重写代码。第一部分是C语言的命名标准。1.一般原则1。所有命名都应使用标准英语单词或缩写。不要使用拼音或拼音缩写,除非该名称描述了中文特有的内容,如半角、全角、首字母、韵母等。2、所有命名都应遵循意义原则,即名称应具有明确的意义。3.所有命名都不应太长,并应控制在规定的最大长度内,一般不超过32字节。C语言命名规范的第一部分,1。一般规则4。所有的命名都应该尽可能使用全名。5.如果使用缩写命名,应尽可能使用通用缩写;如果你不知道一般的缩写,你必须做出评论和解释。6.缩写原则形成缩写的几种技巧1)
4、去掉所有不在前缀中的元音。例如,屏幕写为scrn,原始写为prmv。C语言命名规范的第一部分,6,缩写原则2)使用每个单词的第一个字母或多个字母。例如,通道激活被写为通道激活,释放指示被写为重新链接。3)使用变量名中的每个典型单词。将失败记录为失败计数。4)删除无用的单词后缀、ed等。例如,寻呼请求被写为寻呼请求。5)使用标准或习惯缩写(包括出现在协议文件中的缩写)。例如基站识别码、移动应用部分。C语言命名规范的第一部分,6,缩写原则,缩写标准: 1)缩写应一致。例如,不要有时将频道缩写为Chan或Ch。长度有时缩写为len,有时缩写为Len。2)在源代码头添加注释,解释与协议相关的和非通用的
5、缩写。3)标识符的长度不得超过32个字符。第一部分是C语言命名规范,第二部分是具体规范。1.项目名称是根据项目命名的,可以反映项目最重要的特征。例如,在天马公司的Windows控制程序中,项目名称可以命名为TWIN 2,文件名基于项目名称,前三个字母应该表示它与哪个项目相关。下面的字母应该能够区分不同的功能。严格区分大小写。长度不限于8.3格式,建议不要超过30个字符。如果文件用于定义和实现函数(类),建议文件名与函数(类)的名称一致。第一部分是c语言命名规范;2.文件名,例如,TWIN项目文件名的前三个字符是tw _,tw _ toolposmeter . CPP tw _ mach par
6、ameter . CPP tw _ spindle pos . CPP等。第一部分是c语言命名规范;3.功能名称是指项目的特定命名规范。建议使用动宾结构。函数名应该清楚地反映函数的功能和用途。函数名的最大长度不能超过30个字符。函数名是复合词,第一个字母大写,其他字母小写。全局函数必须以小写前缀g开头。);第一部分是C语言的命名标准。4.原则上,变量名的命名遵循匈牙利符号。即:前缀型变量名,其中:前缀是可选的,用小写字母表示;基本类型是必需的,用小写字母表示;变量名是必需的,多个单词(或缩写)可以组合在一起,每个单词的首字母大写。变量名的最大长度不得超过20个字符。第一部分是C语言命名标准,4
7、。变量名的前缀列表如下:前缀含义,例如,ms_ class ms_ListFunc m_ class成员变量或m_ListBox的静态成员变量,模块级变量m_Size s_ static全局变量s_Count g_ common全局变量g_MyVar,第一部分是C语言命名标准,4。变量名的基本类型列表如下:基本类型含义示例B布尔by byte byNum c字符cMyChar i integer iTestNumber u无符号整数uCount ul无符号长整数ulTime w word wPara,第一部分C语言命名规范,4。变量名的基本类型的例子:双字dwPara l长lPara f浮点数
8、dData长浮点数字dData h句柄hWnd p指针pTheWord lp长指针lpCmd a数组aErr,第一部分C语言命名规范,4。变量名的基本类型的例子:字符串,sTemp sz NULL终止的字符串,szTrees enm枚举类型,enmDays xy x,y坐标,xyPos,第一部分,C语言命名规范,5。类名反映了特定的含义,其原则是清楚地表达类的目的和功能。接口必须以大写的I开头,代表接口。当名字由多个单词组成时,每个单词的第一个字母必须大写。C语言命名规范的第一部分,6,宏和常量的命名规则:单词的所有字母都是大写的,每个单词都可以用下划线分隔。命名示例:为:#定义最大值100
9、#定义最大值_插槽_ num8 #定义ei _ encr _ info0x07 #定义do(do)iret=do;if(iRet)返回IRet;C语言命名规范的第一部分,7,结构和结构成员的名称,每个单词的字母都是大写的,单词之间可以用下划线连接。Typedef可以使用也可以不使用,但是为了保持一致,typedef可能不用于某些结构,有些可能不使用。结构变量以小写字母“t”作为前缀。typedefstructPOINT intxintyt点。结构成员的命名规则与变量的命名规则相同。C语言命名规范的第一部分,8。枚举和枚举成员的命名每个单词的字母都是大写的,单词之间可以用下划线隔开。枚举成员的命
10、名规则:单词的所有字母都是大写的,每个单词都可以用下划线分隔;每个成员的第一个单词必须相同。枚举变量以小写字母“e”作为前缀。命名示例: typedef enum _ kfile _ open _ mode file _ open _ readonly=0,file _ open _ readwrite=1,file _ create _ always=3 ek file _ open _ mode;C语言命名标准的第一部分,9,联合名称的每个单词的字母都是大写的,并且这些单词可以用下划线连接。联合变量名以小写字母“j”为前缀,其成员以变量命名。示例:typedefunion _ VARIAN
11、T charcValintiVallonglVal浮点值。jVARIANT第二部分是C语言编程规范。首先,总体要求是在工程项目之前应该建立代码编写规则。这条规则应该贯穿整个采用标准代码编写惯例可以大大简化项目的维护负担。第二部分是C语言编程规范,第二部分是具体的编程规范1。基本要求1.1程序结构清晰易懂,单个功能的程序行数一般不应超过200行。1.2简化代码以避免垃圾程序。1.3尝试使用预定义的变量。1.4不要任意定义全局变量,尽量使用局部变量。1.5使用括号来避免歧义,第二部分是C语言编程规范,2。可读性要求2.1可读性第一,效率第二。2.2保持注释与代码完全一致。2.3每个源程序文件都有一
12、个标题描述。规格见规格。2.4每个函数都有一个函数头描述。规格见规格。2.5当定义或引用主要变量时,注释可以反映它们的含义。2.7用相应的指令定义全局变量。2.8处理过程的每个阶段都有相关的注释。2.9典型算法之前有注释。2.10一行只写一句话,并使用空格、空行和过渡,以确保清晰的视觉效果。第二部分C编程标准,2。可读性要求2.11使用缩进来显示程序的逻辑结构,缩进量被一致地定义为两个空格。2.12循环时,支管水平不应超过五层。2.13注释可以与语句在同一行,也可以在上面一行。2.14空行和空白字符也是特殊注释。2.15清晰的陈述,无评论。2.16注释的范围可以是:定义、引用、条件分支和一段代
13、码。2.17注释行数(不包括程序头和功能头描述)应占总行数的1/5至1/3。C语言编程规范的第二部分,2。可读性要求示例1:函数的可读性格式是长getaxisstatus (int iaxiscode,long * lstatus)长lstatus;长lResultsetaxisadress(IaxisCode);lResult=GetStatus(lResult);返回lResult上述函数内容缩进2个空格,可读。C语言编程规范的第二部分,2。可读性要求示例2:一行中只有一条语句,错误可以用空格对齐:长度=32,长度=16;正确的例子:长度=32;iWidth=16,C语言编程规范的第二部分
14、,2。可读性要求示例3:如果(暂时等)。)语句使用不正确:如果(a=3)b=6;如果(a=3)b=6;上面例子的书写格式似乎没有层次感。C语言编程规范的第二部分,2。可读性要求示例3:如果(暂时等)。)语句的格式正确:如果(a=3)b=6;内容缩进2个空格,层次清晰,可读性强。C语言编程规范的第二部分,2。可读性要求示例4:错误使用开关语句的示例:开关(代码)案例0:中断;案例1:中断;默认值break上面例子的书写格式似乎没有层次感。C语言编程规范的第二部分,2。可读性要求示例4:开关语句的正确使用:开关(代码)盒0:断开;案例1:中断;默认值break内容缩进2个空格,层次清晰,可读性强。
15、第二部分,C语言编程规范,3,结构要求,3.1,禁止两个等价分支。3.2一般禁止GOTO语句。3.3使用IF语句强调两组语句中只有一组被执行。否则禁止转到。3.4使用案例实现多路径分支。3.5避免多个出口流通。3.6一般功能只有一个插座。3.7不要使用条件赋值语句。3.8避免不必要的分支。3.9不要轻易用条件分支替换逻辑表达式。第二部分是C语言编程规范。4.正确性和容错性的要求。4.1程序首先是正确的,其次是美丽的。4.2它不能证明你的程序没有错误。因此,在写完一个程序后,你应该根据详细的设计进行检查。4.3在纠正错误时,可能会出现新的错误,因此在修改前应首先考虑对其他程序的影响。4.4所有变量必须在调用前初始化。4.5必须检查所有用户输入的合法性。4.6当程序和en之间存在关系时,第二部分是C语言编程规范,5。可重用性要求5.1完成相对独立功能的可重用算法或代码应该抽象为公共控件。5.2公共控制应该考虑面向对象的思想,减少外部联系,并考虑独立性或封装性。5.3应使用模板建立公共控制。C语言编程规范的第二部分,6。注释6.1根据项目要求设置注释语言;6.2文件开头的注释包括:公司名称、版权、作者姓名、时间、模块用途、背景介绍等。复杂的算法需要添加过程描述;6.
温馨提示
- 1. 本站所有资源如无特殊说明,都需要本地电脑安装OFFICE2007和PDF阅读器。图纸软件为CAD,CAXA,PROE,UG,SolidWorks等.压缩文件请下载最新的WinRAR软件解压。
- 2. 本站的文档不包含任何第三方提供的附件图纸等,如果需要附件,请联系上传者。文件的所有权益归上传用户所有。
- 3. 本站RAR压缩包中若带图纸,网页内容里面会有图纸预览,若没有图纸预览就没有图纸。
- 4. 未经权益所有人同意不得将文件中的内容挪作商业或盈利用途。
- 5. 人人文库网仅提供信息存储空间,仅对用户上传内容的表现方式做保护处理,对用户上传分享的文档内容本身不做任何修改或编辑,并不能对任何下载内容负责。
- 6. 下载文件中如有侵权或不适当内容,请与我们联系,我们立即纠正。
- 7. 本站不保证下载资源的准确性、安全性和完整性, 同时也不承担用户因使用这些下载资源对自己和他人造成任何形式的伤害或损失。
最新文档
- 2025至2030年中国层烤炉行业发展研究报告
- 2025至2030年中国小儿智力糖浆行业投资前景及策略咨询报告
- 2025年中国胶原蛋白粉市场运行态势及行业发展前景预测报告
- 2025至2030年中国吸板器市场现状分析及前景预测报告
- 2025至2030年中国古旧桌行业投资前景及策略咨询报告
- 2025年中国电子控制燃油喷射系统市场前景预测及未来发展趋势报告
- 2025年中国黑茶行业发展运行现状及投资战略规划报告
- 2025至2030年中国厌氧螺丝锁固密封胶行业投资前景及策略咨询报告
- 2025年中国海带行业投资分析及发展战略研究咨询报告
- 2025年镜子市场分析报告
- 常见恶性心律失常的护理
- 浙江省杭州市金丽衢十二校2024-2025学年高三下学期(3月)第二次联考数学试题 含解析
- 2025年1月浙江省高考物理试卷(含答案)
- 天然气站租赁合同
- 2024年贵州贵州乌江煤层气勘探开发有限公司招聘笔试真题
- (一模)2025年广州市普通高中毕业班综合测试(一)生物试卷
- 第二季度营销计划与执行方案
- 中国急性缺血性卒中诊治指南2023
- 2025年河南工业和信息化职业学院单招职业适应性测试题库一套
- 安徽六校2025年高三2月春季素质检测地理试题及答案
- 音响师培训教程课件
评论
0/150
提交评论