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

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

投稿者プロフィール

林 晃
林 晃macOS/iOSアプリ/SDK/ミドルウェア開発が専門の開発者
アールケー開発代表。macOS/iOSアプリ/SDK/ミドルウェア開発が専門の開発者。ObjC/Swift/C++使い。豊富な開発実務経験を基に、教育コンテンツ開発、技術書執筆、技術指導、技術セミナー講師、企業内研修講師、行政・自治体職員研修講師も行います。

基礎から学ぶMetal


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

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

詳細

基礎から学ぶSwiftUI


「基礎から学ぶ SwiftUI」というタイトルの本を執筆しました。

SwiftUIの入門書です。

SwiftUIのコンセプトは「ユーザーインターフェイスを作るための最短パスを提供する」「一度学べば(Appleのプラットフォームの)どこにでも適用できる」です。

SwiftUIの概要から始まって、一つ一つのテクノロジートピックに注目しながらSwiftUIとは何か?どんなことができるのか?どのようなコードを書けば良いのかなどを丸々一冊使って解説しています。

詳細

最近の著書

  1. 基礎から学ぶ SwiftUI

最近の記事