Subversionのコメントはしっかり書いた方が良い

私はSubversionを使ってソースファイルの構成管理をしているのですが、コミットするときに、今まではコメントを書かなかったり、Mantis のチケット番号だけを書いていました。Mantisの方に詳細が書いてあるのだから、そっちを見れば良いと考えていました。コードの方は差分を見れば良いとも思っていました。
しかし、Subversionと連携して動くTracを使ってみると、それよりもしっかりと何をどうしたのか書いた方が良いということに気がつきました。TracはSubversionと連携して動くことができるWikiです。チケット管理もできます。このTracにはTimelineという機能があって、Subversionでコミットしたときのコメントが日付ごとに整理されて一覧表示してくれます。ここで、しっかりとしてコメントを残しておくと、これがそのまま作業報告書のように見えてきます。Mantisの方にもしっかりとは書きますが、Subversionの方にはもっとコードよりのことや、理由を書きます。これを後からTracのTimeline機能で見ると、何をしたのかが一目瞭然。共同作業しているなら、別のメンバーの作業もはっきりとわかります。Tracを使っていないプロジェクトでも、CornerstoneなどのSubversionのクライアントではコメントを日付ごとに整理して表示してくれるので、コメントがしっかり書いてあれば、同様の効果があります。
少し日にちが空いた後に「何をしていたっけ?」考える、それどころから「昨日は何をしていたか?」をすぐに思い出せないことがありますが(疲れていますね)、この方法なら、あまり考えずに「将来作業する自分への手紙」を作れて、このぼ〜っとした時間が減ってくると思います。それと、「今日もよく働いた」という気持ちも出てきて、モチベーションがあがります。

関連記事

  1. File Manager由来のAPIがDeplecatedになっていた…

  2. Gitの管理ディレクトリを分離する

  3. PHPからkakasiを呼び出す

  4. インターネットリカバリをするためのネットワーク設定

  5. Webサイトのリニューアル その2

  6. Markdown

最近の著書

最近の記事