ブログ

リーダブルコードを読んでみて

サイバーウェーブインターン生8ヶ月目の吉松です。

 

今回はリーダブルコードという書籍を読みました!

 

概要は以下の通りです。

・書籍名 リーダブルコード

・出版社 オライリージャパン

・書籍内容説明

コードは理解しやすくなければならない。

本書はこの原則を日々のコーディングの様々な場面に当てはめる方法を紹介します。

名前の付け方、コメントの書き方など表面上の改善について。

コードを動かすための制御フロー、論理式、変数などループとロジックについて。

またコードを再構成するための方法。さらにテストの書き方などについて、楽しいイラストと共に説明しています。

 

こちらの本を手にとった理由は一つはフリーランスの友人からおすすめされたこと。

 

そしてもう一つは単純に綺麗なコードを書けたほうがそりゃ良いよなと思ったからでした。

 

読んでみて

 

言語は違えど、コードを綺麗に書くという概念自体はどの言語も共通しているので、Rubyを扱っていても全く違和感なく読むことができました。

 

特にこの本を読んで勉強になったことを3つ紹介します。

 

  • メソッド名や変数名に意味を持たせるということ。

 

たとえば

 

def get_page(url)

 

みたいなメソッドをつくろうとしたとき、getの意味が広すぎて、ローカルキャッシュからとってくるのか、データベースからなのか、インターネットからなのか

 

もしインターネットからであれば

 

def download_page(url)

 

みたいな変数名のほうが明確になります。

 

  • 長いコードを描きすぎないこと。

 

実際に現場でも一つの式でいろんなメソッドてんこ盛りのコードを書いたことがありますが、

 

後々そのコードを見ると何の値を取ろうとしているのか一見してわからないことがありました。

 

この本の中でなんども繰り返し言われていることが、全く外部の人がコードを見ても理解できるコードを書きなさいと書かれていました。

 

先ほどの変数名もそうですが、一つのコードが長すぎることは、それ自体で読みにくくなってしまいます、

 

読みにくいので、仮に外部の人が入ってきても理解するのに時間がかかってしまうということでした。

 

まぁ自分でも書いたコードが分からなくなるというのは最悪ですね

 

  • コメントを残すところはしっかり残す。そうでないものはコメントすべきでない。

 

コメントすべきでない例として、コードでわかることはコメントしないということです。

 

変数名やメソッド名を工夫することで、わざわざコメントを書かずに意味を通じるようにするなどです。

 

逆にコメントを書くべきものはコードに欠陥が残っている場合や、関数の全体の要約ということでした。

 

他にももっとコードを綺麗にするための考え方が詰まっている本なので何周も読みたいと思う本でした。

 

 

仲間を募集

『WEBテクノロジーで社会に幸せを作る!』そんな想いに共感してくれる仲間を募集しています。

サイバーウェーブでは、AIなどの新しいことにもチャレンジできる環境を提供し、メンバーひとり一人のスキルアップ・ステップアップを全力で応援しています。

個人の成長が会社の成長に繋がります。

◆インターン採用はこちらから

インターン採用

◆新卒・既卒・第二新卒採用はこちらから

新卒・既卒・第二新卒

 

 

おすすめ記事

お問合せはこちら。
お気軽にご相談ください。

電話アイコン 03-5206-8490
業務および採用に関するお電話はこちら