在SVN倉庫中包含doxygen文檔

Question

在SVN倉庫中包含並提交我的項目的Doxygen HTML文檔是否是一種好的做法？

Answer 1

我傾向於說沒有自文檔生成的東西。

雖然可能是可能有用的情況（例如，當釋放包含文檔的版本時），但生成的內容應該保留在VCS之外。

版本化文檔只有在每次提交之前新生成文檔（在我的經驗中通常不會完成）時纔有意義。否則，可能會出現生成的文檔與實際代碼不匹配的情況。

版本doxyfile.dox（您存儲您的生成設置的地方）。如果您分發這些設置，則可以在安裝項目期間即時生成文檔。