调试技巧总结

一.调试

1.什么是调试

调试，通俗易懂地说就是不断排查代码的错误，进行修正的过程，在写代码的时候，我们会经常碰到一个问题：代码的执行不符合我们的预期结果。这时，就需要自己进行手动调试，纠正其中的错误，调试是一个非常重要的技巧，没有任何人可以保证他的代码写出来就是一定正确的，这里也只是举例一些我个人认为实用的技巧，因为要调试的技巧严格来说，需要具体情况，具体分析，它更加需要实战经验的层层叠加

2.调试语义的分类

在mit计算机科学及编程导论，提到了一个概念——语言的语义，课程的教授将编程语言的语义进行划分成两类：static（静态）、full（动态）

2.1 静态语义

定义：静态指的是该语言在运行前（编译阶段）对代码语义规则的检查，比如：使用的变量是否声明过，使用的语法非法（对空指针解引用，负整数进行取模）

检查方式：根据编译器报错和警告信息的提示，去相应的地方排查

2.2 动态语义

定义：动态指的是语言在运行时进行的语义规则的检查，这些规则关注的是代码的实际行为，该一语义就是调试场景中最为常见的

检查方式：在代码的执行过程中

例子：

具体讲解：计算机科学及编程导论（第一集的39.53）

二.实用的调试技巧

这里提供的技巧，重在讲解如何通过讲述的方法进行调试，而相应的例子是我自己在写代码时候碰到的场景，尽可能地融进我所搭建的场景去感受使用对应技巧纠正的过程

1.屏蔽代码

在写代码时，可能我们根本找不到代码出错的位置，因为如果是编译语义它还不能进行调试，这是可以挨着挨着屏蔽部分代码，进行错误定位，再进行规则分析

前置场景：使用C++实现vector数据结构时，正写完了vector的迭代器区间的构造，再测试test_vector7时出现了错误
实例：

//vector.h
//在自己包含的实现其结构，并包含相应的测试函数
#include<assert.h>
#include<iostream>
using namespace std;namespace sy
{template<class T>class vector{public:typedef T* iterator;typedef const T* const_iterator;iterator begin(){return _start;}iterator end(){return _finish;}const_iterator begin() const{return _start;}const_iterator end() const{return _finish;}void swap(vector<T>& x){std::swap(_start, x._start);std::swap(_finish, x._finish);std::swap(_end_of_storage, x._end_of_storage);}vector(){}vector(const vector<T>& x){reserve(x.capacity());for (auto& e : x){push_back(e);}}//正写完的构造函数template <class InputIterator>vector(InputIterator first, InputIterator last){while (first != last){push_back(*first);first++;}}vector(size_t n, const T& val = T()){reserve(n);while (_finish != _end_of_storage){*_finish = val;_finish++;}}vector(initializer_list<T> il){reserve(il.size());for (auto& e : il){push_back(e);}}vector<T>& operator=(vector<T> x){swap(x);return *this;}~vector(){if (_start){delete[] _start;_start = _finish = _end_of_storage = nullptr;}}size_t capacity() const{return _end_of_storage - _start;}size_t size() const{return _finish - _start;}T& operator[](size_t i){assert(i < size());return _start[i];}void reserve(size_t n){if (n > capacity()){size_t old_size = size();T* tmp = new T[n];if (_start){for(size_t i = 0;i < old_size ;i++){tmp[i] = _start[i];}delete[] _start;}_start = tmp;_finish = _start + old_size;_end_of_storage = _start + n;}}void push_back(const T& x){if (_finish == _end_of_storage){size_t newcapacity = capacity() == 0 ? 4 : 2 * capacity();reserve(newcapacity);}*_finish = x;++_finish;}void pop_back(){assert(_finish > _start);--_finish;}void insert(iterator pos,const T& x){assert(pos >= _start);assert(pos <= _finish);if (_finish == _end_of_storage){//异地扩容，pos下标应该更新size_t  len = pos - _start;size_t newcapacity = capacity() == 0 ? 4 : 2 * capacity();reserve(newcapacity);pos = _start + len;}iterator it = _finish - 1;while (it >= pos){it[1] = it[0];it--;}*pos = x;++_finish;}void erase(iterator pos){assert(pos >= _start);assert(pos < _finish);iterator it = pos + 1;while (it < _finish){it[-1] = it[0];it++;}--_finish;}void resize(size_t n,T val = T()){if (n > capacity()){reserve(n);while (_finish != _end_of_storage){*_finish = val;_finish++;}}else{_finish = _start + n;}}private:iterator _start = nullptr;iterator _finish = nullptr;iterator _end_of_storage = nullptr;};void test_vector1(){vector<int> v;v.push_back(1);v.push_back(2);v.push_back(3);v.push_back(4);//v.push_back(5);//v.push_back(6);for (size_t i = 0; i < v.size(); i++){cout << v[i] << " ";}cout << endl;vector<int>::iterator it = v.begin();while (it != v.end()){cout << *it << " ";++it;}cout << endl;v.insert(v.begin() + 1, 20);int x = 2;cin >> x;auto p = find(v.begin(), v.end(), x);if (p != v.end()){v.insert(p, x * 10);}for (auto e : v){cout << e << " ";}cout << endl;}void test_vector2(){vector<int> v1(10, 1);vector<size_t> v3(10u, 1u);for (auto e : v1){cout << e << " ";}cout << endl;vector<int> v2 = { 1,2,3,4,5,6 };for (auto e : v2){cout << e << " ";}cout << endl;}void test_vector3(){vector<int> v = { 1,2,3,4,5,6 };for (auto e : v){cout << e << " ";}cout << endl;int x;cin >> x;auto p = find(v.begin(), v.end(), x);if (p != v.end()){v.erase(p);}else{cout << "没有找到" << x << endl;}for (auto e : v){cout << e << " ";}cout << endl;}void test_vector4(){vector<int> v = { 1,2,2,3,4,5,6 };for (auto e : v){cout << e << " ";}cout << endl;}void test_vector5(){vector<int> v = { 1,2,2,3,4,5,6 };for (auto e : v){cout << e << " ";}cout << endl;v.resize(20, 1);for (auto e : v){cout << e << " ";}cout << endl;v.resize(5);for (auto e : v){cout << e << " ";}cout << endl;}void test_vector6(){vector<int> v1 = { 1,2,2,3,4,5,6 };for (auto e : v1){cout << e << " ";}cout << endl;vector<int> v2(v1);for (auto e : v2){cout << e << " ";}cout << endl;vector<int> v3 = { 10,20,20,30 };v1 = v3;for (auto e : v1){cout << e << " ";}cout << endl;}void test_vector7(){vector<int> v1 = { 1,2,2,3,4,5,6 };vector<int> v2(v1.begin(), v1.begin() + 5);string s("hello world");vector<int> v3(s.begin(), s.end());for (auto e : v1){cout << e << " ";}cout << endl;for (auto e : v2){cout << e << " ";}cout << endl;for (auto e : v3){cout << e << " ";}cout << endl;}}//test.cpp
int main()
{sy::test_vector7();return 0;}

当前错误：

①这里我刚完成了迭代器区间的构造，才出现的错误，至少可以断定就是由于该构造引起的，就从当前构造还是调试：

调试1

这里就可以断定：

②此时需要放开该语句，对所有测试函数进行一一排查：

调试2

③已经找到出错的测试函数，并对内部语句进行排查：

调试3

锁定到错误语句位置，展开分析：

解决方案：进行函数重载——这也是官方库里的一种方式

纠正

2.借助打印

有时候我们对代码调试不是一直死调试（只跟着条件代码一句一句走），打印这些技巧用起来会非常快，使用打印可以用代码运行的结果去对比预期，看看到底哪里出错了

前置场景：在做一道算法题时，我写的代码出现了不符合预期的情况
算法题目

注意：这里我不具体讲解算法题目，而只是讲解怎样通过对应调试技巧去纠正我预期的目标，所以调试后的代码也不是算法题的最终呈现形式

当时的想法的代码是这样的：

class Solution {
public:vector<vector<int>> threeSum(vector<int>& nums){sort(nums.begin(), nums.end());size_t i = 0, j = 0, k = 0;vector<int> v;vector<vector<int>> vv;for (i = 0; i < nums.size(); i++){j = i + 1;k = nums.size() - 1;int sum = nums[j] + nums[k];while (j < k){if (sum > -nums[i])  k--;else if (sum < -nums[i]) j++;else{v.push_back(nums[i]);v.push_back(nums[j]);v.push_back(nums[k]);vv.push_back(v);v.clear();break;}}}return vv;}};

但是当我调试看最终返回的结果时，发现只返回了一组值，就说明有问题：

这里就可以用到刚刚提到的技巧：打印；我就在while循环语句中加了这两句打印代码：

有了这两句代码就可以观察nums中的下标问题，可以看看代码到底出了什么问题：

class Solution {
public:vector<vector<int>> threeSum(vector<int>& nums){sort(nums.begin(), nums.end());size_t i = 0, j = 0, k = 0;vector<int> v;vector<vector<int>> vv;for (i = 0; i < nums.size(); i++){j = i + 1;k = nums.size() - 1;int sum = nums[j] + nums[k];while (j < k){//添加打印代码，使得调试更加方便            	cout << i << "->" << j << "->" << k;cout << endl;if (sum > -nums[i])  k--;else if (sum < -nums[i]) j++;else{v.push_back(nums[i]);v.push_back(nums[j]);v.push_back(nums[k]);vv.push_back(v);v.clear();break;}}}return vv;}};

于是我展开了画图分析：

借助打印得到的信息：

上面分析的两个元素下标都有，但是最终返回的结果只有一个组，说明我的代码内部逻辑是有问题的，于是我检查了j和k的两个下标的逻辑，发现是没有问题的，接下来我就进一步细调试，因为我们已经知道还要返回的组的下标是[2,3,4]，所以直接在while循环中借助条件语句在里面打断点：

细调就可以把相关的变量都列出来，好观察细节：

问题出现了：

这里我们k–了以后，用的sum还是上一次的sum就导致没有正确的判断，所以应该把sum那一段语句放到循环里面，这样才能解决当前问题：

返回的结果：

这里对于条件语句打断点需要注意：

• 条件语句如果没有内容，是打断不了的
• 要想能够断的住，可以随便加一条语句（如果仅仅只是声明一个变量也断不住），断点还需打在条件语句中的内容，不能只打在条件语句上
• vs的断点还提供了一种条件断点，借助某种条件打断，可自行去了解

调试后更改的最终代码：

class Solution {
public:vector<vector<int>> threeSum(vector<int>& nums){sort(nums.begin(), nums.end());size_t i = 0, j = 0, k = 0;vector<int> v;vector<vector<int>> vv;for (i = 0; i < nums.size(); i++){j = i + 1;k = nums.size() - 1;int sum = nums[j] + nums[k];while (j < k){int sum = nums[j] + nums[k];cout << i << "->" << j << "->" << k;cout << endl;if (sum > -nums[i])  k--;else if (sum < -nums[i]) j++;else{v.push_back(nums[i]);v.push_back(nums[j]);v.push_back(nums[k]);vv.push_back(v);v.clear();break;}}}return vv;}};

当然，这里调试更改后的代码，只是解决了我那个时候的需求，并不是算法题的最终代码，因为还有去重+固定的i剩余还有其他组的问题，这里也不在讲解了，只是借助这个题目讲解打印这一调试技巧，我在解这道题后面时还是使用过这个技巧

该道算法题的最终的我的写法：

//借助数据结构set去重的版本
class Solution {
public:vector<vector<int>> threeSum(vector<int>& nums){sort(nums.begin(), nums.end());size_t i = 0, j = 0, k = 0;vector<int> v;vector<vector<int>> vv;set<vector<int>> s;for (i = 0; i < nums.size(); i++){j = i + 1;k = nums.size() - 1;while (j < k){cout << i << "->" << j << "->" << k;cout << endl;int sum = nums[j] + nums[k];if (sum > -nums[i])  k--;else if (sum < -nums[i]) j++;else{v.push_back(nums[i]);v.push_back(nums[j]);v.push_back(nums[k]);//借助数据结构set来去重//将插入的v在进行排序sort(v.begin(), v.end());s.insert(v);v.clear();//i固定后，还需判断剩下的元素因为要返回的是所有j++;}}}set<vector<int>>::iterator it = s.begin();while (it != s.end()){for (int i = 0; i < 3; i++){//set里面存储的是vector，*it就是vector//(*it)[i]就是vector内的元素v.push_back((*it)[i]);}vv.push_back(v);v.clear();it++;}return vv;}};//不借助数据结构去重的版本
//该版本的去重操作非常牛逼！！！
class Solution {
public:vector<vector<int>> threeSum(vector<int>& nums){sort(nums.begin(), nums.end());vector<vector<int>> vv;for (size_t i = 0; i < nums.size(); ){size_t j = i + 1;size_t k = nums.size() - 1;while (j < k){int sum = nums[j] + nums[k];if (sum > -nums[i])  k--;else if (sum < -nums[i]) j++;else{vv.push_back({ nums[i] ,nums[j] ,nums[k] });j++, k--;//去重后面的区间while (j < k && nums[j] == nums[j - 1]) j++;while (j < k && nums[k] == nums[k + 1]) k--;}}//去重重复的固定数ii++;while (i < nums.size() && nums[i] == nums[i - 1])  i++;}return vv;}};

3.查看汇编代码

有的时候，实在看不出调试中的代码有任何问题就可以试一下查看汇编代码，汇编代码是不会骗人的，并且在理解底层的一些设计的时候，汇编代码就会显得非常重要，当然真正实践中也不会经常使用这种调试方法，是迫不得已才会使用的技巧

下面来看一道面试题目：
使用delete[ ]释放new[ ]出来的一段连续空间，为什么new出来的空间会多出一个元素的大小？

class A
{
public:A(int a = 0): _a(a){cout << "A():" << this << endl;}~A(){cout << "~A():" << this << endl;}private:int _a;
};

这里会分为四种情况，我们来一一解决，前提：使用new[ ]开辟空间
情况1：含有析构函数，使用delete

int main()
{A* p = new A[5];delete p;return 0;
}

运行：

情况2：含有析构函数，使用delete[ ]

int main()
{A* p = new A[5];delete[] p;return 0;
}

这次运行是没有问题的，并且也是该面试问的问题的场景：
打开内存窗口查看内存：

通过窗口可以看到，p明明只是开辟了5个A大小的空间，但在p地址的前面还存了一个元素的空间，并且为5

delete[ ]的底层原理：

• 在释放的对象空间上执行N次析构函数，完成N个对象中资源的清理
• 调用operator delete[]释放空间，实际在operator delete[]中调用operator delete来释
  放空间

而前面存储的值——5，就是拿来给析构函数用的，因为new出来了5个元素大小，就需要对应相应次数的析构函数才会保证合法释放资源的问题

用汇编代码验证：

情况3：不含有析构函数，使用delete

运行又是正常的，这又是为什么呢？
原因：编译器底层做了优化处理，delete底层调用的是free，free会直接把资源释放得干干净净的，这里可以查看以下内存窗口(只开了5个元素的大小)：

查看汇编：

注意：但是这种写法还是不推荐

情况4：不含有析构函数，使用delete[ ] ——运行没有问题

小结：在使用new和delete的时候要学会匹配对应的进行使用

4.调试技巧总结

调试技巧	使用场景
屏蔽代码	难找到的错误编译信息（不能进行断点观察），便于定位错误代码位置
借助打印	对可能出错的位置进行穷举，快速得到实际运行得到的结果
查看汇编代码	理解底层代码的有利帮手，万不得已的手段