在我的大多数项目中,我都习惯了以下结构:
src/
inc/
ext/
build/
[...]
CMakeLists.txt
README
LICENCEsrc是我的源代码所在的目录,inc是标头,ext是放置外部库的地方(然后由CMake构建)。
这个结构看起来不太好,因为我面临以下问题:
inc目录中,我的标题是私有和公共标题。CMakeLists.txt中,我使用了如下内容:
target_include_directories(${PROJECT_NAME} PUBLIC )问题是,现在所有的头都被传播到超级项目,甚至是私有项目。一个可能的解决方案是在private和public文件夹中包含一个inc,因此:
src/
inc/
private/
public/
ext/
build/
[...]
CMakeLists.txt
README
LICENCE然后我可以用:
target_include_directories(${PROJECT_NAME}
PUBLIC
inc/public
PRIVATE
inc/private
)问题是,是否有人能想到任何严肃的权衡?也许CMake甚至有一个“建议的层次结构”?
发布于 2019-01-25 12:44:50
老实说,我不是CMake的粉丝。我使用GNU make,这是随我的操作系统附带的包,我很高兴,我的代码需要更少的合作者。
不过,撇开CMake不说,我会重新参观这个建筑。
您的文件夹结构,虽然并不少见,但对库或其组件没有任何说明。它没有为未来的维护者提供任何可用的信息。
请考虑以下源代码结构:
src
src/io
src/http
src/pubsub
src/database突然间,我没有读一行代码,就对应用程序(或库)可能是什么以及在哪里可以找到我可能需要检查的每个组件有了强烈的提示。
例如,看看Linux回购。
在库中,这通常更重要,因为(希望)许多人会阅读代码并做出贡献。
所以你可以问包含文件夹在哪里?.
将头文件与源文件分离的问题是,它使维护变得更加困难。
我建议动态创建usr/include (用于安装的公共文件),使用脚本或使用make.但是,既然您使用的是CMake,请考虑指定每个公共头,或者:
另一种常见的选项是,假定公共头与实现标头明显分离(即包含API限制,除了在重大修订期间不进行编辑),就是将它们放在单独的include文件夹中。
https://stackoverflow.com/questions/54364330
复制相似问题