コードの書き方についての考え

長く開発を行っていたり、コードレビューをしたりしていたりすると
どんなコードを記載すればいいのだろう?、どう指摘するのがいいのだろう?
と悩む事が時々があります。

といった事から、個人的に良く気を付けている、コードの書き方についていくつか記載したいと思います。


1.パッと見で分かりやすいコードを作るようにする

開発をしていると、作成したものを誰か引継ぎ、更に誰かに引継ぎ・・・
と担当が変わっていき、全てを忘れた頃に再度担当をするといった事が多々あります

そのため、こう書けばわかりずらいけどコードが短くなってカッコいい!!
というよりはできるだけシンプルに、どのレベルの人が担当になっても問題が無いよう
初心者でも読めるようなコードになるようにしています。


2.階層を深くしすぎない

コーディング規約で指定されている場合も多々ありますが、
処理が複雑になるにつれ、「if」等条件分岐で階層が深くなってしまう場合が時々あります。
感覚的には2階層まではOK、
3階層以上深くなっていくなら
・関数化を試みて外に出す
・もっとシンプルにロジックを組めないか考えてみる
・処理自体を切り分けできないか
とか試しています。


3.コメントを気持ち多めに

コードを書く人によっては、読めばわかるじゃん!とコメントをほとんど書かない人もいます。
または無駄なコメントを残してる所とかもあったりします。
(以前はコメントにメリークリスマス!!とか書かれてる現場とかもあったりしました。。。)
そのため、ほどほどの量。。。といった所は判断が難しいのですが

・少しでも「ん?」となるところにはコメントを付ける
自分が読んでいて迷うところは、他の人が読んだときにまずわからなくなりますし、
忘れっぽい自分としては思い出しやすくなりますので
書くか迷ったときには記載するようにしています。

・間違ったコメント、無駄なコメントを残さない
一時的にTODOとか書くようなメモ書きを忘れずに削除、
元からある処理の流れが変わった場合には忘れずにコメントの方も更新を行い、
コメントと実処理に差異が発生しないようにする。


私の場合、上記の様な内容に気を付けて開発を行っています。
あくまで主観なので、こうした方がいいよーといった事がありましたら指摘頂ければと思います。。。


--------------------------
システム開発のご要望・ご相談はこちらから

コメントを残す

メールアドレスが公開されることはありません。 * が付いている欄は必須項目です