svn - 在 SVN 存储库中包含 doxygen 文档

Question

在 SVN 存储库中包含并提交我的项目的 Doxygen HTML 文档是一种好习惯吗？

Answer 1

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

虽然在某些情况下这可能有用（例如，在发布包含文档的版本时），但生成的内容应远离 VCS。

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

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