编码规范_ 适行.pptVIP

* 程序命名规则 重庆山外山科技有限公司 技术中心 ---软件部 前言 没有一种命名规则可以让所有的程序员赞同，程序设计教科书一般都不指定命名规则。命名规则对软件产品而言并不是“成败悠关”的事，我们不要花太多精力试图发明世界上最好的命名规则，而应当制定一种令大多数项目成员满意的命名规则，并在项目中贯彻实施。 前言 优秀的软件工程师： 无私、协作 缩写 缩写 单元 BLDP 血泵 补液泵 超滤泵 肝素泵 配液板 电导板 驱动板 加热板 平衡腔板 电源板 空气板 漏血板 缩写 单元 BLDP 血泵 SP 补液泵 UFP 超滤泵 HEP 肝素泵 MB 配液板 CB 电导板 DB 驱动板 HB 加热板 BCB 平衡腔板 PB 电源板 AB 空气板 BLP 漏血板 文件目录 QT Creator 头文件 源文件 界面文件（若有） IAR、MDK、ADS BOOT (cortexm3_macro.s、 stm32f10x_vector.c) LIBRARY(STM32库文件) UCOSII （若有） USER(用户文件) DOCUMENT(用户文档、编码规范、头文件、源文件样例、更改记录) 命名规则-头文件 头文件由三部分内容组成： （1）头文件开头处的版权和版本声明 （2）预处理块。 （3）函数和类结构声明等。 命名规则-头文件（顶部注解） 文件： ***.h 作者： *** 版本： V1.0 日期： 03/01/2010 摘要： *** 命名规则-头文件（顶部注解） #ifndef XXXX_H #define XXXX_H #include stdio.h #include “myhead.h” #endif 注：XXXX_H中的XXXX用大写方式，如head.h则写成HEAD_H 命名规则-源文件（顶部注解） （1）版权信息。 （2）文件名称，摘要。 （3）当前版本号，作者/修改者，完成日期。 （4）版本历史信息。 命名规则-源文件（顶部注解） Copyright (c) 2012,重庆山外山科技有限公司技术中心 All rights reserved. 文件名称：***.c/***.cpp 摘 要：简要描述本文件的内容 当前版本：1.1 作 者：输入作者（或修改者）名字 修改内容：简要说明本次修改内容及功能 完成日期：2012年2月1日 取代版本：1.0 原作者 ：输入原作者（或修改者）名字 完成日期：2012年1月10日 命名规则-函数注解 函数名： 外设函数的名称 函数原形： 原形声明 功能描述： 简要解释函数是如何执行的 输入参数 {x} ： 输入参数描述 输出参数 {x} ： 输出参数描述 返回值： 函数的返回值以及返回值的含义 程序注释 注释应对齐 边写代码边注释，修改代码同时修改相应的注释 注释统一用中文 命名规则 变量的名字应当使用“名词”或者“形容词＋名词”。 1、全局变量 g_ 2、成员变量 m_ 3、静态变量 s_ 其它变量命名采用骆驼命名法（camelNameMethod），函数及类采用帕斯卡命名法（CamelNameMethod）Qt中自定义槽函数（SLOTCloseTheWindow），自定义信号函数（SIGNALCloseTheWindow）。 命名规则 常量（包括define定义及枚举）全用大写的字母，用下划线分割单词。 例如： const int MAX = 100; const int MAX_LENGTH = 100; #define MIN_LENGTH 10 程序书写规则 在每个类声明之后、每个函数定义结束之后都要加空行。 // 空行 //注解 void Function1(…) { … } // 空行 //注解 void Function2(…) { … } 程序书写规则 在一个函数体内，逻揖上密切相关的语句之间不加空行，其它地方应加空行分隔。缩进按Tab键（具体缩进方式参照样例工程） // 空行 while (condition) { statement1; // 空行 if (condition) { statement2; } else { statement3; } // 空行 statement4; } 程序书写规