分类: C/C++
2019-12-18 22:28:29
一、 箴言
技术人员设计程序的首要目的是用于技术人员沟通和交流,其次才是用于机器执行。程序的生命力在于用户使用,程序的成长在于后期的维护及根据用户需求更新和升级功能。
如果你的程序只能由你来维护,当你离开这个程序时,你的程序也和你一起离开了,这将给公司和后来接手的技术人员带来巨大的痛苦和损失。
因此,为了程序可读、易理解、好维护,你的程序需要遵守一定的规范,你的程序需要设计。
“程序必须为阅读它的人而编写,只是顺便用于机器执行。”
—— Harold Abelson 和 Gerald Jay Sussman
“编写程序应该以人为本,计算机第二。”
—— Steve McConnell
二、注释风格
1.1 注释的原则是有助于对程序的阅读和理解,注释不宜太多也不能太少。注释语言必须准确、易懂、简洁,没有歧义性。
1.2 程序文件头部代码应进行注释。注释必须列出:版权说明、版本号、生成日期、作者、内容、功能、与其他文件的关系、修改日志等。头文件的注释中还应有函数功能简要说明。
三、 文件的命名
文件的命名要准确清晰地表达其内容,同时文件名应该精练,防止文件名过长而造成使用不便。在文件名中可以适当地使用缩写。 以下提供两种命名方式以供参考:
各程序模块的文件命名开头 2 个消协字母代表本模块的功能:
如:主控程序为 mpMain.c,mpDisp.c 等。
不写模块功能标识:
四、C语言相关术语
声明(declaration):指定了一个变量的标识符,用来描述变量的类型,是类型还是对象,函数等。声明,用于编译器(compiler)识别变量名所引用的实体。以下这些就是声明:
externintbar;
externintg(int,int);
doublef(int,double); [ 对于函数声明, extern关键字是可以省略的 。]
定义(definition):是对声明的实现或者实例化。连接器(linker)需要它(定义)来引用内存实体。
与上面的声明相应的定义如下:
intbar;
intg(intlhs,intrhs)
{
returnlhs*rhs;
}
doublef(inti,doubled){
returni+d;
}
五、头文件中段落安排顺序
1、文件头注释
2、防止重复引用头文件的设置
3、#include 部分
4、enum 常量声明
5、类型声明和定义,包括 struct、union、typedef 等
6、全局变量声明
7、文件级变量声明
8、全局或文件级函数声明
9、函数实现。按函数声明的顺序排列
10、文件尾注释
以上就是的小编给大家整理的关于嵌入式C语言中的编程规范,如果说大家在编程的时候可以更加的规范点的话,那么在之后的代码中就不会出现很大的问题的。如果说你想要学习嵌入式技术的话,那么粤嵌科技欢迎大家来我们公司进行实地考察,并在考察中可以更加深入的了解我们