LoginSignup
70
100

More than 3 years have passed since last update.

リーダブルコード ~実務未経験が知っておきたい15のポイント~

Last updated at Posted at 2020-09-10

はじめに

リーダブルコード読破しました。総ページ237ページ。
マジできつかった・・・。2日程度かけて読み込みましたが、結構しんどいです。
書いているコードをある程度理解するのも難しいので、プログラミング初学者にはあまりおすすめ出来ません。正直後半は流し読みでした(´・ω・`)
それでもかなり実務に役立ちそうな箇所は多くあったので、わかりやすくまとめてこれから実務で実践していく用として記録していきます。

参考文献・参考記事

リーダブルコード ―より良いコードを書くためのシンプルで実践的なテクニック

リーダブルコードを読んだので、殴り書き
この記事にリーダブルコードの全てが記載されていた。この記事読む意味ないので、こっち読んで下さい(・_・)(これ読んだら記事書く意味がなくなったww)

実務未経験が知っておきたい15のポイント

参考文献・参考記事記載の通り、リーダブルコードを読んだので、殴り書き に全てが記載されていたので、個人的に重要と思った15のポイントにしぼって記載します。

基本概念

「コードは理解しやすくなければいけない」
「コードは他人が最短で理解できるコードでなければならない」
「コードは短い方がいいが、"理解するまでにかかる時間"を短くするほうが大切」

15のポイント

1.名前に情報を詰め込む。
2.一貫性を持たせたレイアウトで目に優しいコードを書く。
3.コードから読み取れるコメントは不要。ひどい名前は名前を変える。
4.コメントには自分の考えを記録する。読み手にコードの意図を伝える。
5.コードの欠陥にはコメントをつける。
6.条件式は否定形よりも肯定形を使う。三項演算子はコードが見にくければ、極力避ける。
7.複雑なコードは「もっと簡単なコードがあるはずだ」と考える。最適ライブラリを探したり、短く簡単にする。
8.コードが読みやすくならない変数を削除する。グローバル変数は避ける。変数は一度だけ扱う(できるだけ)。
9.関数やコードブロックをみて「このコードの高レベルの目標は何か?」と自問する。プロジェクト固有のコードから汎用コードを分離する。
10.「一度にひとつのタスク」を行う。そこで行われているタスクをすべて列挙する。タスクをどのように分割するかよりも、分割するということが大切。
11.コードに想いを込める。おばあちゃんがわかるように説明できなければ、本当に理解したとは言えない。読み手が理解できるように「簡単な言葉で」書くべきなのだ。
12.使用する言語のあらゆるライブラリを自分の頭にインプットする。それが読みやすく、短いコードを書くことに繋がる。
13.かっこいい機能の実装について悩まないで、きっと必要ないから。将来的には必要となる保守や文章化などの「負担」時間を忘れがちになるから。シンプルにしよう。
14.コードを小さく保つ。汎用的な「ユーティリティ」コードを作って、重複コードを削除する。
15.平均的なソフトウェアエンジニアが一日に書く出荷用のコードは10行。成熟したライブラリコードの裏側には、膨大な設計・デバッグ・修正・文書・最適化・テスト・が存在する。積極的にライブラリを再利用しよう。

まとめ

本当は5つにするつもりでしたが、重要なことが多すぎて15になりました。
「リーダブルコード」には開発において重要なことが多く記載されています。
リーダブルコードを読んだので、殴り書き
上記の記事が本当にわかりやすいので、強くおすすめします。
ひと目で意識できるサブ用にお使い頂けたら幸いです。

70
100
1

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
70
100