読者です 読者をやめる 読者になる 読者になる

勘と経験と読経

略すとKKD。ソフトウェア開発やITプロジェクトマネジメントに関するあれこれ。

思考停止ワードとコミットログとコードコメント

Project Management

古い記事になるのだけれど、バージョン管理ツールにコミットログのNGワードを登録するという話が面白かった。ソフトウェアは思考がそのまま品質につながるようなところがある。思考停止に近しいワードを禁止してしまうのも手かもしれない。

コミットログのNGワード

注意するのも疲れるし、大抵の場合は注意しても直りません。
そんなわけで、私が面倒を見ている環境だとpre-commit-hooksを使って、規定のバイト数のコメント書かないとコミット出来ないようにして対応しています。
コミットコメントを意地でも書かせたい - almost nearly dead

単にコメント無しを規制するだけではなく、思考停止してしまうようなワードを禁止しているのが素敵。

また、これに加えて会社名や人名も禁止してしまうのはうまいやり方だと思う。人の名前が出てくるとそこで情報が隠蔽されてしまうし、「問題 VS 我々」のスタンスが崩れてしまう。

以前に構成管理警察のことを書いたのだけれども、こういった仕掛けはぜひ武器として取り込んで行きたいと思っている。

コードの中のNGコメント

同じような話として、コードの中に含まれるコメントについてもチェックできるのではないかと考えている。

自分が担当したプロジェクトだと、わりと定期的に全部のコードを検索して気になる単語が含まれてないかのチェックをする。

  • とりあえず
  • こっそり
  • 暫定
  • 回避
  • 一応
  • 不明
  • 未定
  • 懸念
  • 実験
  • 将来
  • いつか
  • あとで
  • 後で
  • 未済
  • 未決
  • バグ
  • コピペ
  • ToDo

いわゆるコード警察業。キーワードは決まったものではなく、割とインスピレーション頼り。その年の流行語などで検索することも多い(今年だと、「倍返し」あたりが怪しい)。これも、コミットログと同様な仕組みで自動的に規制してしまうのもいいかなと思っている。

ただし、たとえばDBやUIに「未決フラグ」とか「将来キャッシュフロー」などの項目があると裏目に出るので注意。