《编码规范适行》ppt课件

《《编码规范适行》ppt课件》由会员上传分享，免费在线阅读，更多相关内容在教育资源-天天文库。

1、程序命名规则重庆山外山科技有限公司技术中心---软件部前言没有一种命名规则可以让所有的程序员赞同，程序设计教科书一般都不指定命名规则。命名规则对软件产品而言并不是“成败悠关”的事，我们不要花太多精力试图发明世界上最好的命名规则，而应当制定一种令大多数项目成员满意的命名规则，并在项目中贯彻实施。前言优秀的软件工程师：无私、协作缩写缩写单元BLDP血泵补液泵超滤泵肝素泵配液板电导板驱动板加热板平衡腔板电源板空气板漏血板缩写单元BLDP血泵SP补液泵UFP超滤泵HEP肝素泵MB配液板CB电导板DB驱动板HB加热板BCB平衡腔板PB电

2、源板AB空气板BLP漏血板文件目录QTCreator头文件源文件界面文件（若有）IAR、MDK、ADSBOOT(cortexm3_macro.s、stm32f10x_vector.c)LIBRARY(STM32库文件)UCOSII（若有）USER(用户文件)DOCUMENT(用户文档、编码规范、头文件、源文件样例、更改记录)命名规则-头文件头文件由三部分内容组成：（1）头文件开头处的版权和版本声明（2）预处理块。（3）函数和类结构声明等。命名规则-头文件（顶部注解）文件：***.h作者：***版本：V1.0日期：03/01/2

3、010摘要：***命名规则-头文件（顶部注解）#ifndefXXXX_H#defineXXXX_H#include#include“myhead.h”#endif注：XXXX_H中的XXXX用大写方式，如head.h则写成HEAD_H命名规则-源文件（顶部注解）（1）版权信息。（2）文件名称，摘要。（3）当前版本号，作者/修改者，完成日期。（4）版本历史信息。命名规则-源文件（顶部注解）Copyright(c)2012,重庆山外山科技有限公司技术中心Allrightsreserved.文件名称：***.c/*

4、**.cpp摘要：简要描述本文件的内容当前版本：1.1作者：输入作者（或修改者）名字修改内容：简要说明本次修改内容及功能完成日期：2012年2月1日取代版本：1.0原作者：输入原作者（或修改者）名字完成日期：2012年1月10日命名规则-函数注解函数名：外设函数的名称函数原形：原形声明功能描述：简要解释函数是如何执行的输入参数{x}：输入参数描述输出参数{x}：输出参数描述返回值：函数的返回值以及返回值的含义程序注释注释应对齐边写代码边注释，修改代码同时修改相应的注释注释统一用中文命名规则变量的名字应当使用“名词”或者“形容词

5、＋名词”。1、全局变量g_2、成员变量m_3、静态变量s_其它变量命名采用骆驼命名法（camelNameMethod），函数及类采用帕斯卡命名法（CamelNameMethod）Qt中自定义槽函数（SLOTCloseTheWindow），自定义信号函数（SIGNALCloseTheWindow）。命名规则常量（包括define定义及枚举）全用大写的字母，用下划线分割单词。例如：constintMAX=100;constintMAX_LENGTH=100;#defineMIN_LENGTH10程序书写规则在每个类声明之后、每个函

6、数定义结束之后都要加空行。//空行//注解voidFunction1(…){…}//空行//注解voidFunction2(…){…}程序书写规则在一个函数体内，逻揖上密切相关的语句之间不加空行，其它地方应加空行分隔。缩进按Tab键（具体缩进方式参照样例工程）//空行while(condition){statement1;//空行if(condition){statement2;}else{statement3;}//空行statement4;}程序书写规则一行代码只做一件事情。一个变量，一条语句intwidth;//宽度in

7、theight;//高度intdepth;//深度x=a+b;y=c+d;z=e+f;程序书写规则程序的分界符‘{’和‘}’应独占一行并且位于同一列voidFunction(intx){//programcode……}程序书写规则类的版式，函数以TAB方式缩进classA{public:voidFunc1(void);voidFunc2(void);…private:intm_i,m_j;floatm_x,m_y;…}突出功能以行为为中心程序书写规则参数的书写要完整，不要贪图省事只写参数的类型而省略参数名字。如果函数没有参数，

8、则用void填充，（包括函数的定义及声明都必须写上完整的参数）。voidSetValue(intwidth,intheight);floatGetValue(void);红色部分不能省略。程序书写规则如果参数是指针，且仅作输入用，则应在类型前加const，以防止该指针在函数体