私は自分のプロジェクトのドキュメントを生成するためにヤードを使用しています。ドキュメントは生成できるので、実際にバージョン管理する必要はありませんが、実際のドキュメントでコード(コメント)の変更の影響を簡単に確認できるため、バージョン管理を行うことにしました。
問題は、ヤードがドキュメントを生成するたびに、各ファイルの先頭の日付が変更され、すべてのファイルが変更されたと見なされることです。
ファイルが変更されたかどうかを検出するためにそれらの行を無視するようにgitに指示する方法、またはファイルが同一である場合にファイルを再生成しないようにyardを構成する方法はありますか?
ありがとう
アップデート
日付が変わってしまったらファイルをきれいにするスクリプトなどができることはわかっています。だから私の質問は、Gitの方法があるということです。つまり、diffドライバーについてわざわざ読んだり、クリーンなスクリプトを実行したりする必要があります。
クリーニングパスに向かっている場合は、gitフックを使用するか、ドキュメント生成に統合する方がよいでしょう。
最終的に、生成されたドキュメントの特定のコミットによる変更を追跡する他の方法に興味があります。
私は自分の問題が何であるか(そしてなぜ私が必要のないものをバージョン管理しようとしているのか)を実際に説明していないので、そこに行きます。
時々、コードの少しの変更がドキュメントを台無しにするので、ドキュメントに関するコミットの影響を見ることができるでしょう。
例:vimにmodelineを使用しています(vimに異なる情報を伝えるファイルの最初の行のコメント)
モジュールのドキュメントを含むファイルがあることを知っている
#vi: my vim setting
# Documentation of module A
module A
.... some code
end
そしてどこか他の場所で私はこのモジュールを使用します
#vi : my vim setting
( 2 blank lines)
module A
.... some different code
end
その時点で、すべてが正常であり、AのドキュメントはになりますDocumentation of module A
。ただし、誰か(私のような)が最後のファイルの空白行を削除して1つだけ残した場合(はい、モードラインとコードの間に2行の空白行を入れます)、ヤードはモードラインがモジュールAのドキュメントであると考えますvi : my vim setting
。
問題は、すべてのページを確認する以外に、ドキュメントが台無しになっていることを検出する方法がないことです。gitを使用すると、何が変更されたかをすばやく確認して確認でき、いつ変更されたかを確認することもできます(これは重要です。変更された理由を理解できるためです)。