まるるん備忘録

プログラミングやインフラ等、IT技術に関して気付いた事を書いているブログです。

【まるるん備忘録】プログラムを組む時はコーディング規約にだけ気を付ければ良い?

プログラムを組む時、コーディング規約を守れば良いコードになると思っていましたが、 コーディング規約を守るのは最低条件だと気付きました。
じゃあ他にどういう事を気を付ければ良いのか、という事を3点に絞って書いていきます。

コーディング規約は必ず守る

当たり前ですがコーディング規約を守るのは最低条件です。
1人でもコーディング規約を守れていないとプログラムを最終的に評価・管理する人がとても辛いです。
必ず守りましょう。

何故その処理が必要なのか説明出来るようにしておく

結局の所、人に何をしているプログラムか説明出来ないとプログラムを使ってもらえません。
概要だけでなく、なるべく詳細についても処理を説明できるようにしましょう。

論理的に妥当だと言えるコードを書く

何故そのコードなのか?
他にもっと良い書き方があるのではないか?
これが説明出来なければプログラムのブラッシュアップが大変です。
きっちり説明できるようになりましょう。

まとめ

私的にプログラムを組む際に大事な事を3点書きました。
「コーディング規約を守っていればそれで良いんじゃないの?」と思っている方はぜひ参考にして良いプログラムを組んでいって下さい。