クリーンコード

覚えておきたい

2025/07/30

・プログラミング中級者になりたい人のためのクリーンコード入門

・リーダブルコード

リーダブルコード

短いコードのほうが優れたコードのように思えるが、読みやすいコードであるとは限らない。

読みやすいコード=他の人が最短時間で理解できるように書かれたコード

命名規則

抽象的な命名より具体的な命名にする。

汎用的な名前は使い所を考える。

get_よりもcatdh_やfetch_

秒数などは単位を変数にいれる 例)start_msなど

password→plaintext_password

長過ぎる名前はよくないと暗黙的な了解らしい

プログラミング中級者になりたい人のためのクリーンコード入門

命名規則

形容詞+名詞

関数:動詞+形容詞+名詞

コメント

コードをみて分かる場合、冗長、形式的なコメントは書かない

関数の中身を説明するコメントは、後々回収して中身が変わった場合面倒になるので書かない

*変数も関数も、その中身を説明するようなコメントは控える

良いコメント

・JSDoc (TSならTSで)

・注意や警告、ルールを書く → アノテーションコメント

・メモ

変数定義

・数値や文字列ベタ書きのマジックナンバー、マジックキャラクターを避け、変数に入れてあげる

・変数の寿命を短くする