C++ 头文件使用规范

一、头文件应该仅仅包含其需要用到的内容，不应包含任何无用的内容

比如A.h中include了B.h，但是A.h中并没有用到B.h，而是A.cpp用到了，一些IDE会提示B.h无用，建议删除。如下图：
但是删除了就会导致编译无法通过，因为A.cpp中引用了A.h，也用到了B.h中的相关内容。

正确做法应该是：把#include B.h移到A.cpp中。

即：头文件应该仅仅包含其需要用到的内容

二、关于宏定义

若此宏定义仅在本文件(A.cpp)中使用，那么建议定义到A.cpp中，若其他文件需要用到，则只能定义在A.h中

三、关于变量的定义和声明

baseinfo.h中定义了一个int变量

#pragma once
#ifndef BASEINFO_H
#define BASEINFO_H

unsigned int headLength=4;

#endif

当我的main.cpp和B.cpp分别引入这个baseinfo.h时，就会报重复定义的错误。

原本以为加了#pragma once 和#ifndef BASEINFO_H #define BASEINFO_H 条件就不会重定义了，其实不然。这两个能够解决头文件重复包含的问题

比如main.cpp引用了B.h和baseinfo.h，B.h又引入了baseinfo.h。 相当于main.cpp一个编译单元包含了两次headLength的定义。但是加入了#pragma once就能避免编译阶段报错。不加就会报错。

如代码：

=======aaa.h========
int length =0;   //定义了一个int变量length


=======bbbb.h========

#include "aaa.h"     //就引入了aaa.h



=========main.cpp========

#include <iostream>
#include "aaa.h"
#include "bbb.h"

int main()
{
    std::cout <<"show message"<<std::endl;
    return 0;
}

而上面依然报错的原因是：编译一个cpp编译单元时是独立进行的。main.cpp和B.cpp在编译时都会将其展开，编译这两个cpp文件都不会报错。但是将这两个链接到一起时，就会发现有两个定义就报错了。

解决方案：

在baseinfo.h中仅作声明，在baseinfo.cpp中添加定义即可。

=========baseinfo.h==========
#pragma once
#ifndef BASEINFO_H
#define BASEINFO_H

extern  unsigned int headLength=4;  //仅仅做声明。添加extern可以让该变量被其他cpp文件所看到

#endif


=========baseinfo.cpp==========
#include "baseinfo.h"

unsigned int headLength = 4;      //在cpp中做定义

总结：

1、#pragma once 和#ifndef xxx_H 能解决编译阶段头文件嵌套引用问题。但是不能解决链接阶段重定义问题。

2、类外的变量（全局变量），在头文件中仅做声明，在cpp文件中做定义。重要！

3、类成员变量，可以在类的声明内部，定义。不会产生重定义问题。如下：

#ifndef LOGGER_H
#define LOGGER_H
#include <iostream>


class Logger
{
public:
    int * headLength=10;     //这里可以做定义
};

#endif // LOGGER_H