自分のプロジェクトの Doxygen HTML ドキュメントを SVN リポジトリに含めてコミットするのは良い習慣ですか?
1 に答える
4
ドキュメントは生成されたものなので、私はノーと言う傾向があります。
これが一般的に役立つ場合もありますが（たとえば、ドキュメントを含むバージョンをリリースする場合）、生成されたコンテンツはVCSから除外する必要があります。
ドキュメントのバージョン管理は、各コミットの前にドキュメントを新たに生成する場合にのみ意味があります（私の経験では通常は実行されません）。そうしないと、生成されたドキュメントが実際のコードと一致しない場合があります。
doxyfile.dox代わりに（生成設定を保存する場所）をバージョン管理してください。設定を配布すると、プロジェクトのインストール中にその場でドキュメントを生成できます。
于 2012-04-05T09:36:10.913 に答える