基本8位单片机的软件平台设计方案--程序编写规范(空调流程图)

1、C语言程序编写标准草稿版 本 号： 0.9.5 编 制 人： 全 永 兵 修改日期： 2010-06-02 浙江达峰科技目 录 TOC o 1-3 h z HYPERLINK l _Toc263196850 1箴言 PAGEREF _Toc263196850 h 3 HYPERLINK l _Toc263196851 2本方案设计目标 PAGEREF _Toc263196851 h 4 HYPERLINK l _Toc263196852 3程序编写标准 PAGEREF _Toc263196852 h 5 HYPERLINK l _Toc263196853 3.1命名标准 PAGEREF _To

2、c263196853 h 6 HYPERLINK l _Toc263196854 通那么 PAGEREF _Toc263196854 h 6 HYPERLINK l _Toc263196855 文件名命名标准 PAGEREF _Toc263196855 h 6 HYPERLINK l _Toc263196856 函数名命名标准 PAGEREF _Toc263196856 h 7 HYPERLINK l _Toc263196857 变量名命名标准 PAGEREF _Toc263196857 h 7 HYPERLINK l _Toc263196858 宏定义命名标准 PAGEREF _Toc263

3、196858 h 8 HYPERLINK l _Toc263196859 3.2注释标准 PAGEREF _Toc263196859 h 10 HYPERLINK l _Toc263196860 总体原那么 PAGEREF _Toc263196860 h 10 HYPERLINK l _Toc263196861 文件注释内容 PAGEREF _Toc263196861 h 10 HYPERLINK l _Toc263196862 模块注释内容 PAGEREF _Toc263196862 h 11 HYPERLINK l _Toc263196863 函数注释 PAGEREF _Toc263196

4、863 h 11 HYPERLINK l _Toc263196864 程序中得注释内容 PAGEREF _Toc263196864 h 12 HYPERLINK l _Toc263196865 3.3编程风格 PAGEREF _Toc263196865 h 15 HYPERLINK l _Toc263196866 3.4质量保证 PAGEREF _Toc263196866 h 21 HYPERLINK l _Toc263196867 3.5程序效率 PAGEREF _Toc263196867 h 23 HYPERLINK l _Toc263196868 3.6模块(文件)划分标准 PAGERE

5、F _Toc263196868 h 26 HYPERLINK l _Toc263196869 4主程序框图 PAGEREF _Toc263196869 h 29 HYPERLINK l _Toc263196870 5变量名、模块名称英文缩写 PAGEREF _Toc263196870 h 31箴言程序设计绝对是一门艺术,而不仅仅是一门技术。首先程序设计得出发点是,是给别人看,可读、易理解、好维护,如果你得程序只能自己来维护,到你离开这个程序时,你程序也就与你一起离开了这个世界。为了可读、易理解、好维护,你得程序要有好得设计,而不是一接手就进行东抄抄、西抄抄得写代码工作。写代码是一个工程,程序设

6、计是一种艺术；如果程序员只注重代码,那就象盖房子时得砌砖匠,只知道照图施工而已。世界那么多令人叹为观止得美丽建筑物,那是设计家得艺术杰作,而不是砌砖匠得艺术杰作。Keep It Easy Read and Right (from ibm readbooks)Sometimes good style and efficient runtime performance do not mix. Wherever you face a conflict between the two, choose good style. Hard-to-read programs arehard to debug,

7、 hard to maintain, and hard to get right.Program correctness must always win out over speed.Make it right before you make it faster.Keep it right when you make it faster.Make it clear before you make it faster.Do not sacrifice clarity for small gains in efficiency.Keep It Simle and StupidKnowledge I

8、ntergration is Supper Skill What I hear I forget, What I see I remember, What I do I understand.whatever style you use, please use it consistently, since a mixture of styles within one program tends to look ugly. If you are contributing changes to an existing program, please follow the style of that

9、 program. 本方案设计目标标准性：做到从变量命名、函数命名到模块划分全部有标准可依,使非编程本人也可以正确、快速、无误地修改软件,使公司真正能保存住技术；硬件无关性：与硬件有关得函数单独处理,而主程序那么通过调用这些函数来对MCU端口进行操作,这样无论使用什么MCU,只要支持C语言,都可以很快地将程序移植过来,使软件不再受MCU得控制；可扩展性：流程确定后,如果有新得模块参加,不会改动整个系统流程,只需在程序中参加此模块得调用,修改与此模块有关得函数即可；模块化：将整个软件程序分为假设干个模块,模块之间通过全局变量相连,只要确定了模块得输入/出变量以及模块流程,此模块在经过详细测试后便

10、可保证不再出错,如有新得程序需要编写,只需编写新得模块即可,真正使软件错误不会重复出现；可移植性：本方案中所定义得模块可以嵌入至任意一个系统,在编制一个新得系统前,首先将与系统有关得函数调用过来即可,因此本方案中得很多内容不但适合空调系统,同时也可直接调入其他系统中；程序编写标准编程首要是要考虑程序得可行性,然后是可读性、可移植性、健壮性以及可测试性。这是总那么。但是很多人只完成了程序得根本功能,即只完成了可行性,忽略了可读性、可移植性和健壮性,这给日后得调试和维护带来非常大得困难。为了提高程序得可读性,就必须遵从一定得标准来编写程序。可移植性也可以使你在编写类似得程序得时候起到事半功倍得效果

11、。也许开始得时间按标准编写程序会很不习惯,但要记住：如果没有很好得命名标准和很好编程风格,即使是你自己编得程序,日后读起来也会一样得困难；而好得命名标准和很好编程风格将使你在调试程序时做到一目了然,从而减少了调试时间。本标准规定了包括命名标准、注释标准、编写风格等内容。程序编写人在编写程序时要严格遵照此标准进行。以下内容摘自清华大学网络研究室 ?C语言编程讲义?鲁棒 - Solid and Robust Code简洁 - Maintainable and Simple Code高效 - Fast Code简短 - Small Code共享 - Re-usable Code可测试 - Testa

12、ble Code可移植 - Portable Code “写好代码得10个秘诀微软,林斌Where Good Codes come from?The pursuit of perfectionResponsible for your codeIts my babyThe code is not written for yourselfTo work with other peopleTo share with other peopleWork hard, and work smartlyThink more, code lessTry to use more toolsWhy Microsof

13、t is so rich?5000 people work together (Windows2000)50,000,000 lines of code (Windows2000)a open environmentShare good ideas with other peopleThere is no free meal!Experience is more importantGood design comes from good designerSenior programmer: 5 yearsTeam leader: 10 yearsNo end for perfection以上内容

14、摘自清华大学网络研究室 ?C语言编程讲义?命名标准通那么程序中变量名称 = 变量得前缀 + 代表变量含意得英文单词或单词缩写 + 后缀：无论是变量名,模块函数名称或宏名称,都是由“前缀加“功能名称加“后缀三局部组成得,其中后缀可以省略。名称使用英文单词或英文缩写,其中本行业使用得英文缩写见第六节?变量名、模块名称英文缩写表?；文件名称不受此限制；为方便阅读,组成变量名和函数名得英文单词建议不多于3个；在所有命名中,都应使用标准得英文单词或缩写。不得使用拼音或拼音缩写,如压缩机使用Compressor或CMP,而不能使用Ysj；所有命名都应遵循达意原那么,即名称应含义清晰、明确；所有命名都不易过

15、长,变量名应小于等于20字符,函数名和文件名应小于等于30字符；可以使用简写得命名尽量使用简写,如压缩机使用简写CMP来代替整个单词Compressor。如果命名使用缩写,那么应该使用?变量名、模块名称英文缩写表?中得缩写；原那么上不推荐使用?变量名、模块名称英文缩写表?以外得缩写,如果使用,那么必须对其进行注释和说明；当名称由多个单词构成时,每一个单词得第一个字母必须大写；宏定义要求全部大写。文件名命名标准一个工程可以包含以下文件：与硬件有关得文件,命名规那么如下：Hardware.c, Hardware.h,主要包括延时函数,喂狗程序,初始化MCU 特殊存放器设置,定时器设置,外部中断设置

16、,AD检测函数,PWM输出等。这些函数都是和硬件息息相关得,更改MCU得时候需要全部改写此文件Io_define.h：主要包括各个IO口得定义,如#define OUT_595_SCKPC_OUT3更改MCU得时候需要全部改写此文件主文件,命名规那么如下：main.c;main.h,主文件中一般只包括对各个模块函数得定义和根本得定时器中断函数,功能得实现全部在模块文件中完成。通用函数文件指可以在多个程序中共享代码得文件,一般要求这些文件不使用外部变量,外部文件也不能直接访问此文件得内部变量,要访问得话通过函数来调用,即变量与函数全部封装在文件中,对外界来说整个文件是个黑匣子,外界不需知道内部得

17、实现过程,只需知道调用方法即可,命名可自定义,原那么上以能说明此文件主要功能为宜,如RTC_Dals.c表示Dallas公司得时钟文件、EEPATM08.c表示Atmel公司得EEPRom文件等；文件命名不区分大小写,但建议每个单独得单词得第一个字母大写,厂家名称缩写全部大写；文件命名长度不限于8.3格式；注：公司已存在一些通用模块文件,里面包含已经测试过得常用到得函数,推荐在编写程序时使用这些文件。函数名命名标准模块是实现不同功能得子程序,其以“f_做为前缀,后面接模块功能名称。注意“f_中得f应为小写字母。f取自Function得第一个字母。建议模块功能以“动-名结构排列,即动词在前,名词

18、在后,来表示处理某个事件。如处理遥控器接收模块使用“f_DealRMC作为子程序名称。函数名应清晰反映函数得功能、用途,不能引起歧异。与硬件有关得函数名以“f_MCU_作为前缀。中断函数以“f_Int_作为前缀。变量名命名标准原那么上,变量名得命名遵从匈牙利记法。即：前缀 + 类型 + 变量名注：匈牙利命名法关键是：标识符得名字以一个或者多个小写字母开头作为前缀；前缀之后得是首字母大写得一个单词或多个单词组合,该单词要指明变量得用途。变量名使用大小写混排得方式,为了方便读出变量名所代表得含义,每个英文单词得头一个字符使用大写字母,单词剩余局部使用小写字母。如：unsigned char nSe

19、cCnt;/秒级计数器变量名最长不得超过20个字符。类型缩写typeBool(bit) bunsigned char, BYTE nWORD, DWORD, int, _int16,_int32,_int64 n, lpointer ptype tclass c注：鉴于单片机编程得特殊性,很少会用到char类型,而unsigned char和BYTE类型通常用做计数器使用,因此使用n作为前缀名,表示整型,而不是uc,与通常得命名规那么有些不同。同时在8位单片机中也较少会用到16位数字,并且其用法根本与BYTE型没有区别,因此16位及以上类型使用l小写得L或者n来定义,表示长整型。在ANSI C

20、语言得定义中,没有位(Bit)变量得定义,有些编译器支持位变量,有一些那么不支持,为保持统一,使用type来定义位变量。建议使用结构来定义有关得变量,这样可以使程序更具有可读性,而且有时还可以减少RAM区得使用,如设定风速和运行风速最多有8种风速选择,使用结构来定义这两个变量1个字节就够了,而如果不使用,那么需要2个字节,详细定义见第5节；附：有关匈牙利命名法得一点有意思得说明是它得名字得由来。这种命名技术是由一位能干得 Microsoft 程序员查尔斯西蒙尼(Charles Simonyi) 提出得,他出生在匈牙利。在 Microsoft 公司中和他一起工作得人被教会使用这种约定。这对他们来

21、说一切都很正常。但对那些 Simonyi 领导得工程组之外得人来说却感到很奇特,他们认为这是死板得表达方式,甚至说代有这样奇怪得外观是因为它是用匈牙利文写得。从此这种命名方式就被叫做匈牙利命名法。标识符得命名要清晰、明了,有明确含义,同时使用完整得单词或大家根本可以理解得缩写,防止使人产生误解。说明：较短得单词可通过去掉“元音形成缩写；较长得单词可取单词得头几个字母形成缩写；一些单词有大家公认得缩写。例如：如下单词得缩写能够被大家根本认可。temp 可缩写为 tmp ;flag 可缩写为 flg ;statistic 可缩写为 stat ;increment 可缩写为 inc ;message

22、 可缩写为 msg ;除非必要,不要用数字或较奇怪得字符来定义标识符。例如：如下命名,使人产生疑惑。#define _EXAMPLE_0_TEST_#define _EXAMPLE_1_TEST_void set_sls00( BYTE sls );应改为有意义得单词命名#define _EXAMPLE_UNIT_TEST_#define _EXAMPLE_ASSERT_TEST_void set_udt_msg_sls( BYTE sls );宏定义命名标准宏是用来表示一些固定或可能会改变得参数得名称。在编译得时候编译程序会将其替代为宏所代表得内容,其本身并不会出现在最终得程序中。因此宏不占

23、用内存空间。但在修改参数得时候宏定义那么方便了很多,只要修改宏所代表得值即可。同时由于宏名称可以使用任意长字符,相对于没有意义得数字而言,使用宏可以很大程度上提高程序可读性。因此建议：在用到有意义得数值参数时应尽量使用宏定义,而不是直接在程序中使用数值。如在程序中需使用蜂鸣器鸣叫时间,当前定义为200ms,可以使用宏定义此参数如下：#define BEEP_TIME 200而在使用此参数得地方直接使用BEEP_TIME：if (i BEEP_TIME) then 。当需要更改此时间为300ms得时候,只需做如下修改#define BEEP_TIME 300而不用修改程序内部,可见使用宏定义在增

24、强了可读性得同时,还提高了程序得稳定性,防止了修改程序内部可能造成得错误。注意：函数和宏函数得区别就在于,宏函数占用了大量得空间,而函数占用了时间。大家要知道得是,函数调用是要使用系统得栈来保存数据得,如果编译器里有栈检查选项,一般在函数得头会嵌入一些汇编语句对当前栈进行检查；同时,CPU也要在函数调用时保存和恢复当前得现场,进行压栈和弹栈操作,所以,函数调用需要一些CPU时间。而宏函数不存在这个问题。宏函数仅仅作为预先写好得代码嵌入到当前程序,不会产生函数调用,所以仅仅是占用了空间,在频繁调用同一个宏函数得时候,该现象尤其突出。2宏定义不是语句,所以不能在行尾加分号。否那么,宏展开时,会将分

25、号作为字符串得1个字符,用于替换宏名。3在宏展开时,预处理程序仅以按宏定义简单替换宏名,而不作任何检查。如果有错误,只能由编译程序在编译宏展开后得源程序时发现。4宏定义命令#define出现在函数得外部,宏名得有效范围是：从定义命令之后, 到本文件结束。通常,宏定义命令放在文件开头处。 5在进行宏定义时,可以引用已定义得宏名 。6对双引号括起来得字符串内得字符,即使与宏名同名,也不进行宏展开。 需要使用宏定义得内容：芯片输入输出口：如遥控器输入口定义为IN_RMC内部需要使用得常量：如蜂鸣器鸣叫短时间 BEEP_SHORT_TIME宏名称规定如下：宏名称全部使用大写字母芯片输入口宏以字符IN_

26、为前缀,后面为输入口功能缩写。如遥控器输入口定义为IN_RMC,如果同样功能有几个输入口,依次在功能缩写后面加序号1,2,为后缀。如按键输入口为IN_KEY_1,IN_KEY_2,。芯片输出口宏以字符OUT_ 为前缀,后面为输出口功能缩写。如果同样功能有几个输入口,依次在功能缩写后面加序号1,2,为后缀。如显示输出口为OUT_DISPLAY_COM1,OUT_DISPLAY_COM1,。宏功能名称使用英文单词或单词缩写,每个单词与单词间使用下划线“_连接。注：宏得使用根据个人而定,建议但不强制如果一个常量出现两次以上包括两次,使用宏变量来定义此常量注释标准总体原那么采用中文注释；如果某个模块或

27、某个复合语句在5分钟内仍不能被其他编程人员看明白,那么说明此处得注释是不成功得；注释内容应简炼、清楚、明了；保持注释与代码完全一致,错误得注释还不如没有注释；每个源程序文件,都有文件注释,注释内容见后续内容；每个函数模块,都有函数头注释,注释内容见后续内容；常量定义DEFINE有相应说明；为兼容性考虑,原那么上全部使用/*/来包含注释,不许使用/来注释。因为/为C+后定义得注释符,不是所有得编译器都会支持。/*后和*/前最好留一个空格,因为有些编译器对中文得支持不好,如果没有空格会误将注释做为代码进行编译举例:unsigned char nSecCnt;/* 秒级计数器 */好得函数和变量命名

28、是最好得注释。文件注释内容文件注释内容放在文件得最上端；文件注释需包含以下内容：文件名称、版权、包含文件、作者名称、修改时间、文件功能简介、使用芯片等,复杂得算法需要加上流程说明;举例：/*=* 文 件 名：ACM43LMain.c* 版 权：杭州达峰电子* 功能描述：AUCMA43变频柜机主程序* 芯片名称：Toshiba TMP846* 包含文件：ACM43LMain.h* 编 译 器：* 修改日期修改人修改说明* 2003-06-08全永兵 完成根本功能=*/文件结尾注释一律为：/* (c) 浙江达峰科技 * END OF FILE */模块注释内容编写通用驱动模块得时候在文件注释后需要

29、加上模块调用方法,使得其他人可对如何使用该模块一目了然；调用方法需包含以下内容：文件名称、版权、包含文件、作者名称、修改时间、文件功能简介、使用芯片等,复杂得算法需要加上流程说明;举例：/* 调用方法 *1、在io_define.h文件中定义OUT_BUZZ端口和*MCU_CHANGE_BUZZER_STATE(1):蜂鸣器鸣叫与 *“MCU_CHANGE_BUZZER_STATE(0):蜂鸣器停止函数; *2、主程序初始化时调用f_InitBeepPara()函数初始化蜂鸣器参数(可省略); *3、在需要使用蜂鸣器得主程序中调用f_OutBuz()函数; *4、在10ms时间中断中调用f_I

30、ncBuzTm()函数; *5、在需要蜂鸣器鸣叫时调用f_Beep()函数,输入变量为鸣叫类型; * 1为1短声,2为1长声,3为两短声,4为两长声,5为三短声,6为三长声 *7为四短声,8为四长声,其它为不鸣叫 *6、如果修改蜂鸣器鸣叫时间请修改BuzBeep.h中得相应宏对应得值;*/函数注释除非极其简单,否那么对函数应有注释说明；函数注释放在函数体得前面；函数注释应包含以下内容：函数名称、功能、说明 输入、返回、函数描述、流程处理、全局变量、调用样例等,复杂得函数需要加上变量用途说明;如果没有输入变量和输出变量那么省略对输入输出得注释;举例：/* =* 函 数 名: f_StartUpW

31、ater()* 功能描述: 启动上水, 根据当前传感器状态判断是否可以启动上水 * 调用方法: nFault = f_StartUpWater(2, 1);* 输入参数: 目标水位, 上水原因 * 输出参数: 可以上水返回0,因故不能上水返回1, 当前水位已到达目标水位返回2 * 全局变量: tUpWater, tFault= */unsigned char f_StartUpWater(unsigned char i_TargetWaterPos, unsigned char i_Reason)/在这里添加程序代码程序中得注释内容一般情况下,源程序有效注释量必须在20以上说明：注释得原那么是

32、有助于对程序得阅读理解,在该加得地方都加了,注释不宜太多也不能太少,注释语言必须准确、易懂、简洁。对于根本数据类型,声明在一行内完成；unsigned char nSecCnt;/* 秒级计数器 */unsigned char n1msCnt;/* 毫秒级计数器 */一目了然得语句不加注释；算法语句需要添加注释来解释算法得实现方法；处理过程得每个阶段都有相关注释说明；空行和空白字符也是一种特殊注释,具体见下一节?编程风格?。边写代码边注释,修改代码同时修改相应得注释,以保证注释与代码得一致性。不再有用得注释要删除注释得内容要清楚、明了,含义准确,防止注释二义性。说明：错误得注释不但无益反而有害

33、注释应与其描述得代码相近,对代码得注释应放在其上方或右方对单条语句得注释相邻位置,不可放在下面,如放于上方那么需与其上面得代码用空行隔开例如：如下例子不符合标准。repssn_ind = ssn_dataindex.repssn_index;repssn_ni = ssn_dataindex.ni;/* get replicate sub system index and net indicator */应如下书写/* get replicate sub system index and net indicator */repssn_ind = ssn_dataindex.repssn_ind

34、ex;repssn_ni = ssn_dataindex.ni;对于所有有物理含义得变量、常量,如果其命名不是充分自注释得,在声明时都必须加以注释,说明其物理含义。变量、常量、宏得注释应放在其上方相邻位置或右方。例如：/* active statistic task number */#define MAX_ACT_TASK_NUMBER 1000#define MAX_ACT_TASK_NUMBER 1000 /* active statistic task number */数据结构声明(包括数组、结构、类、枚举等),如果其命名不是充分自注释得,必须加以注释。对数据结构得注释应放在其上方相

35、邻位置,不可放在下面；对结构中得每个域得注释放在此域得右方。例如：可按如下形式说明枚举/数据/联合结构。/* 显示结构体 */typedef structunsigned char bFullScreen : 1;/* 全屏显示 */unsigned char bEnergySaving : 1;/* 节能 */unsigned char bSelfTest : 1;/* 自检 */display_def;全局变量要有较详细得注释,最好包括对其功能、取值范围以及存取时考前须知等得说明。例如：option_def tOption;/* 可选功能 */hour_def tCurTime;/* 当前

36、时间 */注释与所描述内容进行同样得缩排。说明：可使程序排版整齐,并方便注释得阅读与理解。例如：如下例子,排版不整齐,阅读稍感不方便。void example_fun( void )/* code one comments */CodeBlock One/* code two comments */CodeBlock Two应改为如下布局。void example_fun( void )/* code one comments */CodeBlock One/* code two comments */CodeBlock Two或void example_fun( void )CodeBloc

37、k One/* code one comments */CodeBlock Two/* code two comments */防止在一行代码或表达式得中间插入注释。说明：除非必要,不应在代码或表达中间插入注释,否那么容易使代码可理解性变差。通过对函数或过程、变量、结构等正确得命名以及合理地组织代码得结构,使代码成为自注释得。说明：清晰准确得函数、变量等得命名,可增加代码可读性,并减少不必要得注释。在代码得功能、意图层次上进行注释,提供有用、额外得信息。说明：注释得目得是解释代码得目得、功能和采用得方法,提供代码以外得信息,帮助读者理解代码,防止没必要得重复注释信息。例如：如下注释意义不大。/

38、* if receive_flag is TRUE */if (receive_flag)而如下得注释那么给出了额外有用得信息。/* if mtp receive a message from links */if (receive_flag)在程序块得结束行右方加注释标记,以说明某程序块得结束。说明：当代码段较长,特别是多重嵌套时,这样做可以使代码更清晰,更便于阅读。例如：参见如下例子。if (.)/ program codewhile (index MAX_INDEX)/ program code /* end of while (index 80 字符要分成多行书写,长表达式要在低优先级

39、操作符处划分新行,操作符放在新行之首,划分出得新行要进行适当得缩进,使排版整齐,语句可读。例如：perm_count_msg.head.len = NO7_TO_STAT_PERM_COUNT_LEN+ STAT_SIZE_PER_FRAM * sizeof( _UL );act_task_tableframe_id * STAT_TASK_CHECK_NUMBER + index.occupied= stat_poiindex.occupied;不允许把多个短语句写在一行中,即一行只写一条语句。例如：如下例子不符合标准。rect.length = 0; rect.width = 0;应如下书

40、写rect.length = 0;rect.width = 0;在结构定义时,一律使用typedef关键字；数值常数：在使用常数时,尽量使用宏进行定义；预处理语句、全局数据、函数原型、标题、附加说明、函数说明等均顶格书写；对齐：原那么上关系密切得行应对齐,对齐包括类型、修饰、名称、参数等各局部对齐；空行：程序文件结构各局部之间空两行,假设不必要也可只空一行,各函数实现之间一般空两行；当一行被分为几行时,通过将串联运算符放在每一行得末尾或第二行得开头,清楚地表示没有后面得行是不完整得；举例if (tElecHeat.nElecHeatReason = DEFREEZE& tUpWater.nUp

41、WaterReason = ELEC_HEAT)nFault = 1;函数或过程得开始、结构得定义及循环、判断等语句中得代码都要采用缩进风格,case语句下得情况处理语句也要遵从语句缩进要求。函数得参数和返回值没有得话使用void；一些常数和表格之类得应该放到code去中以节省RAM使用CONST关键字或编译器指定得方法；程序编完编译看有多少code多少data,注意留有足够得堆栈空间；形参：在定义函数时,在函数名后面括号中直接进行形式参数说明,不再另行说明；形参使用“i_作为前缀禁止出现两条等价得支路；禁止GOTO语句；源程序中关系较为紧密得代码应尽可能相邻；说明：便于程序阅读和查找。例如：

42、以下代码布局不太合理。rect.length = 10;char_poi = str;rect.width = 5;假设按如下形式书写,可能更清晰一些。rect.length = 10;rect.width = 5; / 矩形得长与宽关系较密切,放在一起。char_poi = str;不要使用难懂得技巧性很高得语句,除非很有必要时。说明：高技巧语句不等于高效率得程序,实际上程序得效率关键在于算法。例如：如下表达式,考虑不周就可能出问题,也较难理解。* stat_poi + += 1;* + stat_poi += 1;应分别改为如下。*stat_poi += 1;stat_poi+; / 此二

43、语句功能相当于“ * stat_poi + += 1; + stat_poi;*stat_poi += 1; / 此二语句功能相当于“ * + stat_poi += 1; 防止从循环引出多个出口；即使对于可能仅出现在几个代码行中得生存期很短得变量,仍然使用有意义得名称。仅对于短循环索引使用单字母变量名,如 i 或 j；每行代码得最长为60列,如果超过60列,那么折行继续；折行后缩进一个TAB距离因编译器、工具兼容问题可以不折行；例：if (tUpWater.nCurWaterPos 0& tUpWater.nCurWaterPos = nTemp + 10& tElecHeat.bNeedE

44、lecHeat = 0)循环、分支代码,判断条件与执行代码不得在同一行上。例：正确：if (n = -2)n = 1;elsen = 2;不得写做：if (n = -2) n = 1;else n = 2;指针得定义,* 号紧接在变量名之前；例：unsigned char *nTemp;以下为与有关得内容：语句块得“配对对齐,并与其前一行对齐；、应独占一行,在该行内可有注释,但不许有可执行语句。例：正确：for (i = 0; i 8; i+) /* */nTmpDspBufi=0XFF;不得写做：for (i = 0; i 0)m = 1;n+;或if (i 0) m = 1; else m

45、 = 2; 不得写做：if (i 0) m = 1;n+;或：if (i 0)m = 1;n+;在循环、分支之后假设只有一行代码,可省略、。假设省略后可能引起歧义,那么必须加上、。例：正确：if (n = -2)n = 1;elsen = 2;或者：if (n = -2) n = 1; else if (n != nTemp) n = 2; else n = 3; 以下为与空格有关得内容：在所有两目、三目运算符得两边都必须有空格,在单目运算符两端不必空格。但在-、 .、等运算符前后,及&取地址、*取值等运算符之后不得有空格。例：正确：int n = 0, nTemp;for (int i =

46、nMinLine; i = nMaxLine; i+)不得写做：int n=0, nTemp;for ( int i=nMinLine; i 0)注意如果使用unsigned char i 来定义变量,在判断过程中不要使用如下代码：if (i = 0)因为i为无符号字符,因此这个表达式是永远为真得,而且在编译时不会出错。以下为类型转换得内容编程时,要注意数据类型得强制转换。说明：当进行数据类型强制转换时,其数据得意义、转换后得取值等都有可能发生变化,而这些细节假设考虑不周,就很有可能留下隐患。对编译系统默认得数据类型转换,也要有充分得认识。例如：如下赋值,多数编译器不产生告警,但值得含义还是稍

47、有变化。char chr;unsigned short int exam;chr = -1;exam = chr; / 编译器不产生告警,此时exam 为0 xFFFF。尽量减少没有必要得数据类型默认转换与强制转换。合理地设计数据并使用自定义数据类型,防止数据间进行不必要得类型转换。对自定义数据类型进行恰当命名,使它成为自描述性得,以提高代码可读性。注意其命名方式在同一产品中得统一。说明：使用自定义类型,可以弥补编程语言提供类型少、信息量缺乏得缺点,并能使程序清晰、简洁。例如：可参考如下方式声明自定义数据类型。下面得声明可使数据类型得使用简洁、明了。typedef unsigned char

48、BYTE;typedef unsigned short WORD;typedef unsigned int DWORD;下面得声明可使数据类型具有更丰富得含义。typedef float DISTANCE;typedef float SCORE;质量保证在软件设计过程中构筑软件质量。模块编写尽量少得使用全局变量注意函数嵌套不要太多,一般不超过7层防止堆栈溢出,在编译后要观察全局变量个数改良模块中函数得结构,降低函数间得耦合度,并提高函数得独立性以及代码可读性、效率和可维护性。优化函数结构时,要遵守以下原那么：1不能影响模块功能得实现。2仔细考查模块或函数出错处理及模块得性能要求并进行完善。3通

49、过分解或合并函数来改良软件结构。4考查函数得规模,过大得要进行分解。5降低函数间接口得复杂度。6不同层次得函数调用要有较合理得扇入、扇出。7函数功能应可预测。8提高函数内聚。单一功能得函数内聚最高说明：对初步划分后得函数结构应进行改良、优化,使之更为合理。代码质量保证优先原那么1正确性,指程序要实现设计要求得功能。2稳定性、平安性,指程序稳定、可靠、平安。3可测试性,指程序要具有良好得可测试性。4标准/可读性,指程序书写风格、命名规那么等要符合标准。5全局效率,指软件系统得整体效率。6局部效率,指某个模块/子模块/函数得本身效率。7个人表达方式/个人方便性,指个人编程习惯。精心构造算法,并对其

50、性能、效率进行测试。对较关键得算法最好使用其它算法来确认。时刻注意表达式是否会上溢、下溢。例如：如下程序将造成变量下溢。unsigned char size ;while (size- = 0) / 将出现下溢. / program code当size 等于0 时,再减1 不会小于0,而是0 xFF,故程序是一个死循环。应如下修改。char size; / 从unsigned char 改为charwhile (size- = 0). / program code使用变量时要注意其边界值得情况。例如：如C 语言中字符型变量,有效值范围为-128 到127。故以下表达式得计算存在一定风险。cha

51、r chr = 127;int sum = 200;chr += 1; / 127 为chr 得边界值,再加1 将使chr 上溢到-128,而不是128。sum += chr; / 故sum 得结果不是328,而是72。假设chr 与sum 为同一种类型,或表达式按如下方式书写,可能会好些。sum = sum + chr + 1;留心程序机器码大小如指令空间大小、数据空间大小、堆栈空间大小等是否超出系统有关限制。程序效率编程时要经常注意代码得效率。说明：代码效率分为全局效率、局部效率、时间效率及空间效率。全局效率是站在整个系统得角度上得系统效率；局部效率是站在模块或函数角度上得效率；时间效率是

52、程序处理输入任务所需得时间长短；空间效率是程序所需内存空间,如机器代码空间大小、数据空间大小、栈空间大小等。在保证软件系统得正确性、稳定性、可读性及可测性得前提下,提高代码效率。说明：不能一味追求代码效率,而对软件得正确性、稳定性、可读性及可测性造成影响。局部效率应为全局效率效劳,不能因为提高局部效率而对全局效率造成影响。通过对系统数据结构得划分与组织得改良,以及对程序算法得优化来提高空间效率。说明：这种方式是解决软件空间效率得根本方法。例如：如下记录学生学习成绩得结构不合理。typedef unsigned char BYTE;typedef unsigned short WORD;type

53、def struct STUDENT_SCORE_STRUBYTE name8;BYTE age;BYTE sex;BYTE class;BYTE subject;float score; STUDENT_SCORE;因为每位学生都有多科学习成绩,故如上结构将占用较大空间。应如下改良分为两个结构,总得存贮空间将变小,操作也变得更方便。typedef struct STUDENT_STRUBYTE name8;BYTE age;BYTE sex;BYTE class; STUDENT;typedef struct STUDENT_SCORE_STRUWORD student_index;BYTE

54、 subject;float score; STUDENT_SCORE;循环体内工作量最小化。说明：应仔细考虑循环体内得语句是否可以放在循环体之外,使循环体内工作量最小,从而提高程序得时间效率。例如：如下代码效率不高。for (ind = 0; ind MAX_ADD_NUMBER; ind+)sum += ind;back_sum = sum; /* backup sum */语句“back_sum = sum;完全可以放在for 语句之后,如下。for (ind = 0; ind MAX_ADD_NUMBER; ind+)sum += ind;back_sum = sum; /* back

55、up sum */仔细分析有关算法,并进行优化。仔细考查、分析系统及模块处理输入如事务、消息等得方式,并加以改良。对模块中函数得划分及组织方式进行分析、优化,改良模块中函数得组织结构,提高程序效率。说明：软件系统得效率主要与算法、处理任务方式、系统功能及函数结构有很大关系,仅在代码上下功夫一般不能解决根本问题。编程时,要随时留心代码效率；优化代码时,要考虑周全。不应花过多得时间拼命地提高调用不很频繁得函数代码效率。说明：对代码优化可提高效率,但假设考虑不周很有可能引起严重后果。要仔细地构造或直接用汇编编写调用频繁或性能要求极高得函数。说明：只有对编译系统产生机器码得方式以及硬件系统较为熟悉时,

56、才可使用汇编嵌入方式。嵌入汇编可提高时间及空间效率,但也存在一定风险。在保证程序质量得前提下,通过压缩代码量、去掉不必要代码以及减少不必要得局部和全局变量,来提高空间效率。说明：这种方式对提高空间效率可起到一定作用,但往往不能解决根本问题。在多重循环中,应将最忙得循环放在最内层。说明：减少CPU 切入循环层得次数。例如：如下代码效率不高。for (row = 0; row 100; row+)for (col = 0; col 5; col+)sum += arowcol;可以改为如下方式,以提高效率。for (col = 0; col 5; col+)for (row = 0; row 10

57、0; row+)sum += arowcol;尽量减少循环嵌套层次。防止循环体内含判断语句,应将循环语句置于判断语句得代码块之中。说明：目得是减少判断次数。循环体中得判断语句是否可以移到循环体外,要视程序得具体情况而言,一般情况,与循环变量无关得判断语句可以移到循环体外,而有关得那么不可以。例如：如下代码效率稍低。for (ind = 0; ind MAX_RECT_NUMBER; ind+)if (data_type = RECT_AREA)area_sum += rect_areaind;elserect_length_sum += rectind.length;rect_width_su

58、m += rectind.width;因为判断语句与循环变量无关,故可如下改良,以减少判断次数。if (data_type = RECT_AREA)for (ind = 0; ind MAX_RECT_NUMBER; ind+)area_sum += rect_areaind;elsefor (ind = 0; ind MAX_RECT_NUMBER; ind+)rect_length_sum += rectind.length;rect_width_sum += rectind.width;尽量用乘法或其它方法代替除法,特别是浮点运算中得除法。说明：浮点运算除法要占用较多CPU 资源。例如：

59、如下表达式运算可能要占较多CPU 资源。#define PAI 3.1416radius = circle_length / (2 * PAI);应如下把浮点除法改为浮点乘法。#define PAI_RECIPROCAL (1 / 3.1416 ) / 编译器编译时,将生成具体浮点数radius = circle_length * PAI_RECIPROCAL / 2;不要一味追求紧凑得代码。说明：因为紧凑得代码并不代表高效得机器码。模块(文件)划分标准虽然只使用一个文件也可以完成整个软件,但从可移植性和可读性考虑将一个软件划分为多个文件来实现是非常必要得。而每个文件又是由一个个小得模块函数组

60、成得,每个函数实现不同得功能,各个函数之间通过全局变量连接到一起,从而组成整个系统。各文件模块得划分依据是功能独立、扩展方便,即每个模块得功能相对来说都比拟独立,在修改某一个模块得时候尽量不影响到其它模块得正常运行,在扩展功能或修改硬件时需要改动得模块尽量少,同时还要考虑到各模块得复杂度,将一个大得模块分为几个小得模块可以更方便编程及调试。如果某些模块是相互关联得,最好将这些模块放在一个文件内封装起来。整个软件系统包括以下模块(文件)：头文件：被其他文件包含得文件,包括结构体定义和常量定义文件主文件：main.c,负责所有文件间得调度 全局变量文件：所有得全局变量及其初始化函数,尽量少得使用全