良いコードとは何か　@TECH CAMP#8

　どうも、学んだことは細々とアウトプットをしていこうと思いました、とだです。

　プログラミングを学び始めた自分にとって、良いコードを書くとはなんなのかはっきりとイメージすることができませんでした。今日はこの点について、自分なりにめちゃくちゃ簡単にまとめて備忘録のような感じでメモ書きとして残しておこうと思います。

良いコードとは

　良いコードとは、ズバリ読みやすいコードのこと。そして読みやすいコードとは、「他の人が短時間で理解できるように書かれている」ことを言う。

　私はまだ実際の開発現場を知らないので具体的なイメージはできないのですが、数人であるものを開発するときに、同じチームのメンバー内でお互いにわかりやすいコードを書いた方がいいのは自分でもわかります。
　他の人と良いコミニュケーションを取るために、相手に分かりやすい、誤解のない伝え方や言葉選びをすべきなのと同じなのかもしれません。あえて難しい記述をして、「難しいプログラムを作ってやったぜ」と無駄な小手先のテクニックを使ってイキるなんて恥ずかしいことする意味なんてないですもんね。

　相手に短時間で理解してもらえるコードにはいくつかの要素があるようです。

良いコードの要素

良いコードの要素は以下の3つがある。
1.命名規則
2.コードのレイアウト
3.コメント

1.命名規則についてもう少し具体的にいうと以下の5点に気をつける。

a.明確で具体的な単語を選ぶ
→メソッド名は他の開発者がひと目で意味を理解できるようにする。
b.汎用的な名前を避ける
→[tmp]のような、意味がどうとでも取れるような命名はしない。
c.名前に情報を含める
→変数名に意味を持たせて、他の人に伝わりやすいようにする。
d.誤解されない名前を使う
→使用する英単語が複数の意味を持っていたり、ニュアンスが異なる意味をもっている場合は注意する。名前を長くしてでも詳しく説明する。
e.他の開発者の期待に合わせる
→開発をしていくと、これはこのような動作をするはずという「期待する動作」を他の開発者は持っている。その「期待」に沿うことで冗長な記述を省略できたり、レビューが効率的になりチーム全体の開発スピードが上がる。このような「期待」を裏切らないコードを書くよう心掛ける。

2.コードのレイアウトについては以下の3点に気をつける。

a.整列させる
→縦の位置を揃える。
b.一貫性を持たせる
→コードの中に似たような構造が現れたら、同じフォーマットにする。
c.ブロック化する
→同じ系統の変数などをまとめてグループ化する。それぞれのグループの間に1行空白を開けるなどする。

3.コメントについては以下の3点に気をつける。

a.なぜそのコードを書いたのかをコメントする
→背景や理由を説明するためのコメントを残す。
b.他の開発者へのメモを残す
→他の開発者に伝えたいことをコメントとして残しておく。例えば、誰か他の開発者に直して欲しい箇所を[FIXME]というようにコメントに記入して伝える。
c.実際の例を記入する
→文章だけのコメントでは意図が伝えにくい場合に、実際の挙動の例をコメントで記述しておくこともできる。

まとめ

　上に列挙したポイントそれぞれにさらに具体的な例を挙げることができるようになれば、もっと理解が深まっていった証拠になると思うので、今後学習を進めていった後、またこの記事に戻ってきて編集し直して、より良いまとめになれば良いと思います。