在SVN存储库中包含doxygen文档

Question

在SVN存储库中包含并提交项目的Doxygen HTML文档是不错的做法？

Answer 1

我倾向于说没有，因为文档是生成的东西。

虽然可能可能是有用的情况（例如，在发布包含文档的版本时），但生成的内容应该保留在VCS之外。

只有在每次提交之前新生成文档（根据我的经验通常没有完成），对文档进行版本控制才有意义。否则，可能会出现生成的文档与实际代码不匹配的情况。

版本doxyfile.dox（存储您的世代设置）。如果您分发设置，则可以在安装项目期间即时生成文档。