C++ 代码调试建议

1.代码调试的重要性

代码调试在程序开发阶段占有举足轻重的地位，可见代码调试的重要性。但是有一点必须强调：程序是设计出来的，而不是调试出来的。这是所有程序员必须牢记在心的一条准则。一个没有设计或者这几得很糟糕的程序，无论怎样调试，也不会成为一个合格的程序。

程序有着良好的设计的前提下，软件开发的过程中，编码错误在所难免。所有程序可能出现的错误可分为两类：语法错误和逻辑错误。调试通常是指在消除了语法错误之后，发现程序中的逻辑错误的过程。对C/C++程序进行调试，有这样集中常用的手段。它们既可以单独使用，也可以配合使用。

2.代码调试的几点建议

2.1 使用打印语句

这是最朴素，也是最直接的方法。程序的运行可以看成是一组变量（状态）不断变化的过程，这个过程就是数据处理的过程。如果程序的最终结果不对，那么我们必须考虑这一组状态什么时候出现了问题，而查看中间结果就成了一种最有效的手段。

因此，不要过分迷信功能强大的调试工具。在大部分情况下，程序出现的问题都是一些小问题。而正是这些小问题，却造成了大麻烦。程序员可以通过对最有可能出错的代码附近使用简单的printf()语句或cout<<…语句来输出中间结果，查看异常情况。

2.2 使用调试标记

在调试程序的时候使用相应的辅助代码（如输出中间结果等），在调试完成之后隐藏这些代码，是一种常用的调试策略。

这种策略可以借助于#define、#ifdef、#endif这三个与编译指令来实现。具体地说，就是在调试程序的时候，利用编译器的命令行参数定义调试标记（相当于程序中用#define定义的宏），然后再#ifdef和#endif之间包含相应的调试代码就可以了。当程序最终调试完成后，在生成发行版时，只要在编译器命令行参数中不再提供调试标记，程序中的调试代码就会消失。常用的调试标记为_DEBUG（在VC++ 2012）中，编译器调试版的程序是会缺省定义宏_DEBUG。考察如下程序。

#include <iostream>
using namespace std;

int main() {
	int i=5;
#ifdef _DEBUG
	cout<<i<<endl;
#endif
	cout<<"Hello World!"<<endl;
}

在调试程序的时候，会执行#ifdef和#endif之间的语句。当调试完成之后，由于调试标记_DEBUG失去定义，从而隐藏调试代码。

2.3 使用调试变量

与使用调试标记的方法类似，可以在运行时设置一个供调试用的bool型变量，它的值决定了特定调试代码的开放和关闭。并且可以通过程序的命令行参数来控制该变量的开关。上面的程序经过修改如下。

#include <iostream>
#include <string>
using namespace std;

bool debug;

int main(int argc,char* argv[]) {
	int i=5;
	for(int j=0;j<argc;++j)
	{
		if(string(argv[j])=="debug=on")
		{
			debug=true;
		}
	}
	if(debug)
	{
		cout<<i<<endl;
	}
	cout<<"Hello World!"<<endl;
}

程序通过命令行启动时，只要在命令行参数中指明debug=on，就可以输出调试信息。否则，只是输出程序“正常”运行的部分。这样就具有较高的灵活性。

2.4 使用内置的调试宏

在程序调试的过程中，经常希望知道当前运行的是哪个模块小的哪个函数，在源文件中是第几行等等。如果手工添加这些信息，无疑会给程序员带来很大的负担。因此，C++提供了几个宏，他们分别是__FILE__、__FUNCTION__和__LINE__，可以利用它们“自动“获取有关模块、函数和行的信息。考察如下程序。

#include <iostream>
using namespace std;

void func1() {
	cout<<__FILE__<<endl;
}

void func2() {
	cout<<__FUNCTION__<<endl;
}

void func3() {
	cout<<__LINE__<<endl;
}

int main(int argc,char* argv[]) {
	func1();
	func2();
	func3();
}

在本人的机器上输出如下信息：

e:\lvlv_study\synchronousfile\school\2015.10.23\programming\debug\main.cpp
func2
13

另外还可以使用assert()宏来进行断言。assert是一个只在调试版本下起作用的宏。另外，用户也可以定义自己的宏辅助来完成调试任务。例如下面的红可以用来显示变量的值，而且变量的名字会一同显示出来：

#define PR(x) cout<<#x”=”<<x;

这是利用#对宏的参数进行字符串化的处理。

2.5 利用调试工具进行调试

利用集成开发环境进行调试也是一种准则。可以在IDE中设置断点、但不调试、查看变量的内存值、动态修改变量的值以改变程序的执行路径等。每一种具体的调试工具，其调试命令和方法都有差异，使用时要参阅相应的文档（如MSDN等）。

要说明的一点是，使用工具进行调试与基于打印输出的调试除了在使用的方便程度上有所差异外，在某些特殊的情况下，不能活着很难用工具进行某些程序的调试。如在Windows程序设计中，要调试与窗口重绘的有关代码，就不适合用IDE进行调试。原因是焦点从IDE窗口转到应用程序的窗口时，会引发新的重绘动作，导致程序运行陷入“死循环“。Linux环境下，进行代码的调试，我们可以借助于强大的调试工具gdb，其可以快速的定位到程序出错的位置，如使用bt或where命令可以快速找到程序出现core dumped的位置。利用gdb调试程序的段错误可以参考我的另一篇blog：Linux下使用gdb调试core文件。

3.总结

使用各种调试的手段或工具，其目的是尽早的发现已经存在于程序中的错误。与此相关联的问题是，如何较少的引入错误、如何有策略地使用调试手段。给出几条如下建议。

（1）采用良好的变成风格。比如，用统一的规范为变量、函数和类型命名。程序的基本单位（如函数）的规模控制在一定范围之内（如100行），锯齿形编码，合理的注释等等。

（2）进行代码复查。这是Watts S Humphery领导的研究小组指定的PSP（Personal Software Process，即个人软件过程）规范中提倡的做法。在编译之前就进行代码复查，比直接进行编译更能有效地发现程序缺陷。

（3）对历史数据进行统计和跟踪。每个程序员的只是背景和工作习惯各不相同，通过统计历史上个人最容易出现哪些类型的编程错误，以便在将来有针对性地排查，是一种有效的提高程序质量的做法。

---

参考文献

陈刚.C++高级进阶教程[M].武汉：武汉大学出版社，2008.P379-382