A-LOAM代码注释学习（一）common.h和tictoc.h

---

一、代码注释

1.1 common.h文件

主要定义了弧度和角度转换的函数。

#pragma once                          //#ifndef可以针对一个文件中的部分代码，而#pragma once只能针对整个文件（物理上）
                                      //在C/C++中，#pragma once是一个非标准但是被广泛支持的方式。
#include <cmath>                      //基础数学运算库

#include <pcl/point_types.h>          //PCL对各种格式的点的支持头文件

typedef pcl::PointXYZI PointType;     //对激光点云类型进行宏定义，为pcl::PointXYZI 类型起新名字PointType

inline double rad2deg(double radians) //inline内联函数，提高效率，减少内存
{
  return radians * 180.0 / M_PI;      //M_PI是c++语言中标准库<cmath>定义的宏，值为3.14159265358979323846
}

inline double deg2rad(double degrees)
{
  return degrees * M_PI / 180.0;
}

1.2 tictoc.h文件

定义了计时的类，在各节点中计算代码的运行时间。

#pragma once

#include <ctime>         //时间类的头文件
#include <cstdlib>       //提供一些函数与符号常量
#include <chrono>        //日期时间处理库，其中包含3种时钟：system_clock，steady_clock，high_resolution_clock

class TicToc      //定义一个TicToc类
{
  public:         //公有成员
    TicToc()
    {
        tic();
    }

    void tic()    //成员函数tic
    {
        start = std::chrono::system_clock::now();  //获取系统当前时间system_clock给start
                                                   //起点是epoch,即1970-01-01 0点
    }

    double toc()  //成员函数toc
    {
        end = std::chrono::system_clock::now();     //获取当前时间给end
        std::chrono::duration<double> elapsed_seconds = end - start;   //end-start作差求得时间长度
        return elapsed_seconds.count() * 1000;      //把elapsed_seconds的单位 秒 转换成 毫秒 输出
    }

  private:        //私有成员
    std::chrono::time_point<std::chrono::system_clock> start, end;  //std::chrono::time_point：记录时间点，不能被外部访问
};

二、重要内容解析

2.1 inline函数

• inline是C++关键字，在函数声明或定义中，函数返回类型前加上关键字inline，即可以把函数指定为内联函数。这样可以解决一些频繁调用的函数大量消耗栈空间（栈内存）的问题。关键字inline必须与函数定义放在一起才能使函数成为内联函数，仅仅将inline放在函数声明前面不起任何作用。inline是一种“用于实现”的关键字，而不是一种“用于声明”的关键字。
• 内联函数一般只会用在函数内容非常简单的时候。这是因为，内联函数的代码会在任何调用它的地方展开，如果函数太复杂，代码膨胀带来的恶果很可能会大于效率的提高带来的益处。内联函数最重要的使用地方是用于类的存取函数。

参考链接: inline用法详解

2.2 命名空间

当C++工程较大时，程序内存在大量的变量、函数和类，如果这些变量、函数和类都存在于同一个作用域中，一不小心就可能会导致命名冲突。为了解决这个问题，C++引入了命名空间(namespace)这个概念，这样在不同的命名空间中允许存在同名的标识符。有了命名空间我们就可以在程序中有效地避免命名冲突。
参考链接: 命名空间的定义、使用和存在的意义