一个好的C++项目应该包含哪些部分?(文档、生成文件、测试等)

简化列表:

• 文件的位置和形式应便于查找和阅读,包括
  • 关于如何建造它的说明;
  • 使用说明。
• 一些信心测试(“我编译了它,但是 工作 “?”.

无论文档是HTML、纯文本还是源代码注释;无论readme.txt中是否有makefile、批处理脚本或copy&paste one liner;无论您是否有全面的单元测试套件或“黄金文件”测试:

其实没关系。

重要的是你可以 建造 它, 测试 它,以及 使用 尽可能容易。

添加个人意见:

吻。(保持简短。)

对于小项目使用简单的源代码注释,并且只有当您的增长超过某个点时才开始使用doxygen。确保你的文档框架 更努力 通过全文搜索来找到东西,因为根据我的经验,除非你写了你的文档,否则人们最终会这样做 真正地 好。

使用一个简单的makefile,只在必要时使用更复杂的东西(比如cmake、automake等)。对于小项目来说,与“真实”源文件相比,“元数据”的数量可能变得荒谬。

你可以在这个“支持型演员阵容”中投入相当多的时间和精力,在一个项目开始的时候,这个阵容应该投入到项目本身。构建系统、文档等可以根据需要进行扩展,但一旦发布项目体系结构,它本身就很难重构。这就是你的主要关注点。