綺麗なソースコードを書きたい
先週、数ヵ月前に自分で書いたソースコードを見る必要があったのですが、直ぐに処理を追うことが出来ませんでした。
つまり書いたソースコードが汚かったということです。恥ずかしい･･･
散々、良いコードを書けと言っておきながらですからね･･･
ここでは、戒めも込めて「何故このようになったのか」「どうすべきだったのか」を残しておこうと思います。
開発時の内容
- Web系の開発、
Java - 作業は既に動いているサービスへの機能追加
- 既存のコードはボロボロで解析が困難
- 自分の作業は既存の画面に似た新規画面追加だったため、元からある画面を再利用する方向
Javaなのにフレームワークの制約で決まった形でしか継承は使えない そして、既存コードがそうなっていない。(これは割り切りましたw)- 上記から、共通機能は
public staticなメソッドとして切り出すようにした
陥った問題
変数名
モードを表す説明変数を用意していたのですが、変数名を見てもどういったモードなのか判断できませんでした。
開発時はそれで分かると思っていたのでしょうが、もう一歩下がって詳細が分かる命名にすべきでした。
普段から気を付けている事だけにショックです。
中途半端な共通化
共通処理を抜き出す過程でやりすぎました。そのため、メソッドA -> メソッドB -> メソッドCという風に関数呼び出しがネストしすぎて追い難かったです。
メソッドコールの最適化も考えんとあかんなと感じました。
コメントがない
基本的には不要なのですが、長い計算式などはやはり理解に１分以上掛かるのでコメント要るなと思いました。
俺天才コード
無理に１行で書いたコードとか。こういった難しくなっている環境ではより分かり易くした方が良いですね。
まだまだ底辺脱却できないorz
