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

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

投稿者プロフィール

林 晃
林 晃アプリ開発者
アールケー開発代表。Appleプラットフォーム向けのアプリ開発が好きなアプリ開発者。アプリの受託開発、技術書執筆、技術指導・セミナー講師。3DCGコンテンツ作成にも取組中です。

基礎から学ぶARKit


「基礎から学ぶARKit」を執筆しました。本書はARKitを使ったARアプリの開発方法を解説した技術書です。

ARKitを使ってARアプリを作るときの流れや基本的なAPIの使い方などをサンプルアプリを作りながら学べます。

詳細

基礎から学ぶMetal


「基礎から学ぶMetal」を執筆しました。本書はMetalを使ってGPUプログラミングを行うための最初のステップを解説するMetalの解説書です。

私が初めてGPUプログラミングを行ったとき、どこから手をつけて、学んでいけば良いのか分からず呆然としました。もし、あのとき、これを教えてくれればという部分を解説しました。本書で解説している部分はMetalの基礎となる部分で、Metalを使うときに必ず触れることになる部分です。

詳細

関連記事

  1. Mac Pro の強さはベンチマークの数字以外にもある

  2. WordPressが重いときの対策方法

  3. JIRAの要約ページのグラフのこと

  4. Markdown

  5. Mac OS XとWindows間でのハードディスク共有

  6. AppleのApp Storeの審査基準が公開されました

最近の著書

  1. 基礎から学ぶ SwiftUI

最近の記事