最佳做法:src/include 或 src 文件夹旁边的 include 文件夹

Best practice: src/include or include folder next to src folder

本文关键字：文件夹 include src 最佳      更新时间：2023-10-16

项目文件夹结构的最佳或最常用的做法是什么：

project |-- src |-- include

或 

project |--src
              |--include

即将包含文件夹放在源文件夹中或两者相邻？

编辑：

这个建议是相似的：为应用程序级代码分开"包含"和"src"文件夹？，但答案并不令人满意。

如果我要创建一个库，我会像这样做目录结构：

project/
       project_name/
       src/

project_name包含文件的位置。
但是，对于应用程序级项目，这将是我的选择：

project/
    src/

然后src/将拥有所有文件，无论是 .h 还是 .c。
简而言之，除非您正在编写库，否则不要将文件夹用于头文件，因为库需要更有条理，而且它使库易于安装。

我更喜欢将两个文件夹放在同一级别。你必须选择自己的方式。

例如，我更喜欢将源与 makefile 的包含分开，以便对我的项目获得更多可见性。

Project |--src/
        |--include/
        |--others/
        |--obj/
        |--Makefile

根据我的经验，在src目录旁边放置include目录在开源库中更为常见。

请注意，一些库甚至使用另一个细分：它们将库划分为模块（例如 ModA、ModB等），然后为每个模块提供一个include和一个src目录，即 ModA/include、ModA/src、ModB/include和ModB/src。例如，请参阅 PCL 库。

相关文章：