ToDoコメントをぶっ壊す

はじめに

この記事は、Qiita芸人 Advent Calendar 2019の25日目の記事です。

前提

ToDoコメントの定義→「暫定対応(後で修正する可能性があるコード)」

過去自分が経験したプロジェクトでToDoコメントをつけたことで発生した問題

①ToDoと書いてる割に4年5年そのコードが残ってる

これは、大規模システムにありがちなケースなのですがそういったシステムを開発してる現場は入れ替わりが激しいです。なので前任者がToDoと書いて後から直すってことにしていたとしてもその人がやめたらそのコメントは残り続けるわけです。大規模なシステムのコードとかは基本影響のある部分だけを修正するといった形が多いのでそこに影響がある修正が入らない限り一生残り続けることになります。

②ToDoコメントをつけた理由をそもそも忘れる

時間が経つと人間はなぜそんなコードを書いたかを忘れます。
これは時間が経過すればするほどどんどんうろ覚えになっていきます。
結果、どういった可能性があってToDoにしたのかを覚えてる人がいなくなりそもそもToDoコメントをつけた理由を忘れるのです。

③ToDoコメントをつける温度感が人によって異なる

例えば、期限の有り無しですね。
仮対応としていったん対応していつまでに対応しなければいけないといったものなのかそうでないのかでもToDoコメントをつける際の温度感は大きく異なってくると思います。
ここがはっきりしていないと本当は本対応実装後リリースしないといけなかったものが仮対応のままリリースしてしまってバグが発生するといったケースも過去自分の入っていたプロジェクトで経験しています。

ToDoコメントをつける際、気をつけること・解決策

じゃあいざToDoコメントを使うときに何を気をつけるべきか個人的な対策を書こうと思ってます。

①ToDoコメントの対応をチケット管理

期間を設けてそのToDoコメントの対応をチケットで管理するのが一番効果的な気がしますね。
チケット管理してるプロジェクトが前提ですが・・・

②ToDoコメントのコメントに詳細を加える

暫定対応ということが分かるだけでなくなぜ暫定なのか逆に本対応ではどういう対応をするつもりかをコメントに載せておくと後で見た人もわかりやすいので。。。

まあ正直①がちゃんと徹底できていれば②の対策はやる必要ないかなぁと思ってます。

終わりに

タイトルの通り、ぶっ壊すまでは行かないですが・・・
僕が言いたいことは、
「ToDoコメント、つけるならちゃんと管理をしましょう」ということです。