noTitle	sidebarDepth
true	3

はじめに

自分が書いたはずのコードがよく理解できない、という経験はないでしょうか？

• 書いているときは自然に実装したつもりなのに、時間を空けて読み直すと理解するのに時間がかかる
• 一度書いたはずのコードがどこにあるのかわからない
• 仕様が変更されるとどこから手をつければいいのかわからない

このような問題が頻繁に発生すると、開発のスピードが下がるだけでなく、あなた自身のストレスもたまりやすくなります。この本ではこれらを解決するための指針をまとめています。日々のプログラミングにおいて本書が手助けになれば幸いです。

前提

良いコード

「良いコード」の条件はいくつかあります。

• パフォーマンスが良い
• テストしやすい
• バグが少ない
• 簡潔
• etc

この本での定義は読む人が最短で理解できるコードです。理解しやすいコードは変更しやすいからです。パフォーマンスが悪くてテストしにくいコードでも、何をやっているのかが理解できるのであれば改善することができます。簡潔でバグが少ないコードでも、理解できなければ拡張できません。まずは理解しやすいコードを目指しましょう。

::: tip NOTE :pencil2: 「良いコード」とは「読む人が最短で理解できるコード」 :::

ゴール

• 理解しやすいコードを書ける
• 保守性の高いコードを書ける

言語

コードの例を示す際に使用する言語は TypeScript とします。より高機能な言語、逆に低機能な言語もありますが、適宜補完して読んでいただけると幸いです。

注意

この本には多くの場面で適用できる内容をまとめていますが、適用すべきでない場面があったり、過度の適用が逆効果になるものもあります。あくまで指針のひとつとしてください。