ボーイスカウトルールって結局何すればいいんだ

Daily Blogging92日目

ボーイスカウトルールって職場でもネットでもよく聞くし大事なことなんだろうなと思ってたけど、
実際そんな実践できてないしそもそもどういうところを綺麗にしていけばいいんでしょうかね

来た時よりも美しく

Leave your code better than you found it.
これがプログラミングにおけるボーイスカウトルール
Clean Code アジャイルソフトウェア達人の技の中でRobert C. Martinさんが言い出したものらしい

元々は文字通りボーイスカウトの中で使われている言葉から来ている。

Try and leave this world a little better than you found it, and when your turn comes to die, you can die happy in feeling that at any rate, you have not wasted your time but have done your best.

Robert Baden-Powellさん？の言葉らしい
まさかのどっちもRobertさん...!

実際に何すればいいの？

「来た時よりも美しく」とはつまりこういうこと

コードに変更を加える際には、変更前よりもコードベースを良い状態にするよう心がけるべきです。
そうして作業のついでにわずかな改善を施し続けることで、コードの可読性や、作業環境の持続性が高まります。

読みやすいコードのガイドライン -持続可能なソフトウェア開発のために

具体的にどうしたらいいのだろうか
ボーイスカウトだったら、落ちているゴミを拾う、自分たちが持ち込んだものはちゃんと片付けるとかあると思うけど、プログラミングだとどう綺麗にしたら良いのか

具体的な改善例

改善するなんて命名から構造変更など多岐にわたるが例えばこういうやつ

• 不足しているコメントやテストを追加する
• 不要な変数や条件分岐などを削除
• 重複コードの排除
• 関数名、変数名などの命名を適切なものに変更する
• 処理を適切な責務で分割する
• インターフェースを追加して、呼び出しと実装の詳細を分離する

大切なのは...

前よりもちょっとだけでも良いから綺麗にすること
別に大胆なリファクタリングは求めていない

チームのメンバー全員が、ちょっとずつコードを綺麗にしていくことでコードの品質低下を防げる。