質の高いコードとは
概要
- 質の高いコードというのは、人や企業によって異なります。
- より技術レベルが高いものが良いという企業もいるでしょうし、分かりやすいものが良いという企業もあると思います。
- どれかが間違いというわけではなく、それぞれの企業に正解があるということなのでしょう
シックスワンの質の良いコードとは
- 私はプログラムを趣味でするのですが、うっかりすると以前コーディングしてから、半年が経過したりすることがあります。同じように数年前のコードを改めて修正することもあります。
- ある意味、他の人がコーディングした内容をどういうことだろう…って眺めるのと同じように、私も自分が作成したコードをいつも眺めています。
- そのように繰り返すことで、結果として以下のことを心掛けるようになりました。
理解までの速度を最速に
- コードの理解のしやすさは何よりも大事です。変数やクラスの名前も含めて分かりやすくする必要があります。
- 現在のドキュメントの整備もその一つです。
- 必要以上に分岐処理を作らなかったり、ロジックと処理を明確にわけることもそうだと思います。
- 一見して何をしているかわかる、というコードは、複雑なコードもよりもずっと高い価値があります。
リファクタリングしやすい
- 基本的にコードというのは、長期的に付き合っていくものです。
- その場限りのグチャグチャなコードとは異なり、長期的にブラッシュアップしていくものです。
- 「後でここを直そう」というコーディングは悪いものではありません。でも直しやすい、理解しやすいコーディングを心掛ける必要があります。
テストで保証されている
- 基本的にコードはテストで保証されてるべきです。
- テストが保証しているのが、コーディングした時の意図であり、処理自体が完璧である必要ありません。
- テストが書かれていれば、それをいて改善を行うことも用意になります。
まとめ
- シックスワンにおいて、質の高いコードというのは以下のコードです。
- 高度な技術で書かれていなくとも上のようにコーディングされていれば質の高いコードです。
- その意識でコーディングを行っていってください。