おおかみさんの気まぐれ雑記帳

うつ病やSEの経験談、仕事のことや考え方等を気まぐれに書き連ねていきます(´・ω・`) Twitterアカウントは @marrella

プログラムを書く時に意識したいこと

(´・ω・`)こんばんちわ、おおかみさんです

ここ最近、睡眠リズムが崩れ気味で調子悪かったりします(´・ω・`)

こんなときは、半分起きてて半分寝てる、みたいな中途半端な覚醒状態になったりして変な感じするのよねー(´・ω・`)

というわけで今回は、
ボーッとしてたら不意に思い出したプログラムを書く (コーディングする) ときのお話。


1. 可読性

ざっくり言うと、
他人が見ても読みやすいコードを書きましょうね〜
ってこと。

具体的にどうするかっていうと、
1行中に書く命令文は1つだけにする (複数の命令文が1行に繋がって書かれてるとややこしい) とか、
長い命令文になる場合は適度に改行するとか、
階層が一目でわかるようにするとか、
簡潔なコメントを適宜入れるとか。

自分にとって読みやすいのはもちろんなんだけど、他人から見ても読みやすいコード書かないと、
ソースチェックとか面倒になるし、バグ見逃しやすくなるし、後から他人が改修するとなったときに時間かかるし、
意外と影響大きいんだわ。

コーディングしてばっかり、だとこういうの意識し辛いかもしれないけど、
人のソースをチェックする立場になると痛感するのよね、ホント。


2. シンプル

何事もシンプルなのが一番。
なるべく単純なコードに落とし込めるよう頭を使おう
というか、それこそがプログラマのお仕事です。

複雑なコードなんかいらない。
そんなの後から読むとき、めっちゃ苦労するもん。
シンプルなほうが読みやすいし、バグも少ない。


3. 保守性

上の2つはコレのためにある。
いかにメンテナンスしやすいコードを書くか、が重要。

書かれたコードをチェックする、
障害が起きたときに素早く原因究明する、
より短時間でバグを解消し再発を防ぐ、
サービス仕様変更で改修する、
どんなときにもシンプルで可読性の高いコードは必須になる。
そうでないとバグの温床になって後々非常に苦しむことになる。


※当たり前のこと? しかし実際は……

今回は内容短いめ(´・ω・`)
取り上げた3点は基本中の基本。
プログラマなら、そんなもの当然すぎて言うまでもないだろ!と鼻で笑うレベルだと思われる。
それでいい。

が、しかし。

実際の現場では、ベテランさんでもちょいちょいいるのよね。
こんな基本中の基本すら出来てない人たち。

変にコーディング経験豊富なベテランのほうが、そういうの多い印象。

パッと見、なんだこれ?って感じで、
最初から最後まで全部隈なく読んで、何が行われてるのか読み解こうと頑張って、最後の最後で
なるほど!この流れがこう繋がってたのか!すごい!
みたいな、まるでピタゴラスイッチ的な、そんなことになるコード。

うん。面白いんだけどね。
そんなアクロバティックなコードは現場では求められてない。

保守性悪すぎ。
もっとシンプルにできるでしょ?
これ、今後改修入ったとき修正箇所大量発生するけど、そこまで考慮した?

ってなるのよね。

慣れ、はもちろんあるけども、
こればっかりは慣れてきてからでも、
常に意識しながらコーディングしないとやってしまう系だと思う。



それではまた次回

(´・ω・`)ノあでゅー