黄ばんだコードを取り除く

自分はソースコードでハイライトされた警告のことを「黄ばみ」と呼んでいる。

コードエディタ、IDE などでは大抵イエローの背景色や波線、マークで強調されるからで、黄ばみ取るか~という気持ちで作業する。リファクタリングの一種ということで、ホワイトニングと言ってもいいのかもしれない。

ビルドエラーになる赤みとは違って黄ばんだコードはビルドが通らないわけではないので、その瞬間困りが発生するわけではないが、サッと直せるものは何かのついでに直してしまいたいし、難しいものについてはコメントを残しておきたい。

心理的にも気持ちよいものでないのはもちろん、コードベースへの知識がまだ若い、例えば新しいチームメンバーが見たとき、この警告はたまたま見過ごされているのか、何かの難しさがあって仕方なく残ってしまっているのか、その文脈を読み解いたり他の人間に聞いて回るコミュニケーションコストに繋がる。

最も困るのは、警告のハイライトがブロック単位になるとその中の別の警告が埋もれてしまい、実行時に大きな問題の要因になるかもしれない、重要な警告を見逃してしまうことだ。

黄ばんだコードを取り除いてコードリーディングの無用なノイズを減らし、処理の不具合の可能性も見過ごさないようにしよう、というお話。