本文以一个开源项目为例,介绍如何组织一个层次分明、易于检索的文件结构。
如下图是该项目的根目录:
1.README
大写字母命名,放在根目录中,回答“软件要用来干什么?”的问题。
2.LICENSE
大写字母命名,放在根目录中,回答“软件可以拿来用吗?”的问题。
3.src目录
src目录中存放源代码。其中可以进一步划分多个子目录,便于维护。
4.tests目录
src目录中存放测试代码。测试的组织要对应功能代码的组织,便于快速查找。如:src/math的测试代码应放在tests/math中。
5.doc目录
doc目录中存放文档。文档能让用户快速的熟悉软件的使用。
6.3rdparty目录
3rdparty目录中存放项目的依赖项。