通过DEBUG宏定义管理debug模式和release模式

一.引言

  软件版本通常有debug和release两个版本，器本质上是同一套源代码，只是debug版本中为了方便代码调试包含了一些调试信息的输出，而release版本作为最终的稳定发行版本，为了提高程序的运行效率，通常会将这些调试信息删除。同一套源代码怎样实现两种模式的切换，其实很简单，通过DEBUG宏定义的是能与否来决定是否输出调试信息。下面以C语言中常用的两种实现方式为例进行演示，其中第一种包含调试信息的属性信息，用起来更加方便。而第二中通常是内核中调试输出的方法。

二.带有前缀信息的debug调试输出

  当我们想要输出debug调试信息时就定义DEBUG宏，不想输出调试信息时就关闭DEBUG宏(undef).

#include<stdio.h>

/* 输出有前缀信息 */
#define DEBUG		//定义DEBUG宏，表示开启debug调试输出
//#undef DEBUG		//取消定义DEBUG宏，表示关闭debug调试输出

#ifdef DEBUG
#define debug(...) fprintf(stderr, " debug(%s, %s(), %d): ", __FILE__, __FUNCTION__, __LINE__); fprintf(stderr, __VA_ARGS__)
#else
#define debug(...)
#endif

//函数声明
int add(int a,int b);

int main(int argc,char *argv[])
{
	int a = 1;
	int b = 2;
	int c = a+b;
	debug("c = %d\r\n",c);
	int result = add(3,4);
	debug("add(3,4)=%d\r\n",result);
	return 0;
}
int add(int a,int b)
{
	debug("add函数测试\r\n");
	return a+b;
}

输出结果：

 debug(test.c, main(), 21): c=3
 debug(test.c, add(), 28): add函数测试
 debug(test.c, main(), 23): add(3,4)=7

  当我们把undef打开之后，再执行程序就不会输出调试信息了。

三.不带有前缀信息的debug调试输出

#include<stdio.h>
/* 输出无前缀信息 */
#define DEBUG_S3C_MEM
//#undef DEBUG_S3C_MEM
#ifdef DEBUG_S3C_MEM
#define debug(fmt, args...) 	printf(fmt, ##args)
#else
#define debug(fmt, args...) 	do {} while (0)
#endif

int add(int a,int b);

int main(int argc,char *argv[])
{
	int a = 1;
	int b = 2;
	int c = a+b;
	debug("c = %d\r\n",c);
	int result = add(3,4);
	debug("add(3,4)=%d\r\n",result);
	return 0;
}
int add(int a,int b)
{
	debug("add函数测试\r\n");
	return a+b;
}

输出结果：

c=3
add函数测试
add(3,4)=7

  这个debug宏定义是内核中的用法，其中printf本是printk。当我们把undef打开之后，再执行程序就不会输出调试信息了。

四.总结

  通过宏定义来作为调试输出的开关方便实用。__FILE__等是C语言中的预定义宏，就是说这个东西是个宏定义，但是是C语言自己定义的。这些宏具有特殊的含义，譬如__FILE__表示当前正在编译的c文件的文件名。