リーダブルコード
2026年01月15日作成
学んだ事
- 短いコード＝優れたコードではない。仕事の場合は、読みやすいコード＝優れたコードである。
- 変数名や定数名の最後に単位を追加する。例「retryInterval = 1000」これだけだと1000秒に見える「retryIntervalMs = 1000」これは1秒であることが明確。
- フォーマット規約を決めておく。クラスはパスカルケース。定数・変数は、キャメルケース。テーブル名は全て大文字。環境変数はスネークケース。の様な規則があれば、「console.log(DATA)」がテーブル名を出力しているのが一目瞭然になる。
- 当たり前の事はコメントしない。「SUN //日本語だと太陽という意味」これは現代の義務教育を受けた日本人であれば分かるはず。そんなことはコメントしなくていい。
- プログラミング言語毎の標準ライブラリのドキュメントを読む。開発者が欲しいと思う関数は用意されている。
- 単体テストではヘルパー関数をどんどん使う。
- テストの為の実装になる事は避ける。テストをクリアする事が目的ではない。テストはあくまでよりよい実装の手段である事を常に忘れない。
- 保守しにくかったり、更新が億劫になるような単体テストコードは機能していないのと変わらない。