C程序编程规范一
和身边一些学弟们接触发现他们的编程习惯不是太好,对一些基本的规范不重视,今天有时间写一些基本的规范给一些刚入门的新手们,高手可忽略。
首先做项目来说需要建立工程,一般需要几个到几百个上上千个C文件,这就需要对很多C文件提供一个规范,以一般来说,除了main.c文件之外,其他C文件都应该有一个对应的h文件,举个例子:一个工程中有main.c led.c led.h这三个文件,这里led.h就是led.c文件的头文件,头文件一般都是提供函数接口用的,其定义规范如下:
/********************* led.h文件 *********************/ #ifndef __LED_H_ #define __LED_H_ /*这里一般也可以写一些硬件引脚接口*/ void LED_ON(void); //驱动函数,提供外部接口使用 void LED_OFF(void); //驱动函数,提供外部接口使用 #endif
/********************* led.c文件 *********************/
#include "led.h" /**函数说明**/ void LED_ON(void) { /***insert your code***/ } /**函数说明**/ void LED_OFF(void) { /***insert your code***/ }
头文件中#ifndef __LED_H_的意思是如果没有定义__LED_H_,这里一条件编译,一般后面还有#define __LED_H_,这里为什么用大写LED只是大家的编程规范,不大写也没事,最好大写,形成行业规范,便于维护。这样就有一个统一的规范:
#ifndef __文件名大写_H_
#define __文件名大写_H_
//函数声明部分
#endif
对于.c文件格式
#include "文件名"
函数定义部分