在SVN仓库中包含doxygen文档

Question

在SVN仓库中包含并提交我的项目的Doxygen HTML文档是否是一种好的做法？

Answer 1

我倾向于说没有自文档生成的东西。

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

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

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