码泰软件:嵌入式软件开发编程规范及原则!
关于软件开发编程规范及原则,编程规范也就是编写出简洁、可维护、可靠、可测试、高效、可移植的代码,提高产品代码的质量。本文针对软件开发中的嵌入式,主要结合C语言编程的规范给大家讲述。
软件开发原则一、头文件
对于C语言来说,头文件的设计体现了大部分的系统设计,不合理的头文件布局是编译时间过长的原因。
有很多人将工程中所有的头文件包含在一个include.h文件中,然后在每一个.c源代码文件中包含include.h头文件,这样做可以让代码看上去简洁,但实际忽视了编译效率问题,而且代码的可移植性也不好。
软件开发原则二、函数
函数设计的要点:编写整洁的函数,同时把代码有效组织起来。
函数整洁的要求:代码简单直接、不隐藏设计者的意图、用干净利落的抽象和直截了当的控制语句将函数有机组织起来。
软件开发原则三、标识符命名与定义
程序命名是一个关键,如果命名不规范,自己写的代码,时间长了恐怕连自己都不知道是什么意思了。
1、通用命名规则
常见命名风格:
A.用下划线?_?分割,如text_mutex;
B.大小写字母混用,如ReadRFCText。
2、 文件命名规则
因为不同系统对文件名大小写处理会不同,建议文件命名统一采用小写字符。
3、 变量命名规则
首先,全局变量十分危险,通过前缀使得全局变量更加醒目, 促使开发人员对这些变量的使用更加小心。
其次,从根本上说,应当尽量不使用全局变量,增加g_和s_前缀,会使得全局变量的名字显得很丑陋,从而促使开发人员尽量少使用全局变量。
4、 函数命名规则
A.函数命名应以函数要执行的动作命名,一般采用动词或者动词+名词的结构;
B.函数指针除了前缀,其他按照函数的命名规则命名。
5、 宏的命名规则
A.对于数值或者字符串等等常量的定义,建议采用全大写字母,单词之间加下划线?_?的方式命名(枚举同样建议使用此方式定义);
B.除了头文件或编译开关等特殊标识定义,宏定义不能使用下划线?_?开头和结尾。
软件开发原则四、变量
原则:
A.一个变量只有一个功能,不能把一个变量用作多种用途;
B.结构功能单一;不要设计面面俱到的数据结构;
C.不用或者少用全局变量。
软件开发原则五、宏、常量
因为宏只是简单的代码替换,不会像函数一样先将参数计算后,再传递。
建议:
A.除非必要,应尽可能使用函数代替宏;
B.常量建议使用const |
|
|