2022.11.09

【CleanCode】より良いコードを書く技術(変数の定義) ④

おかざきるい

こんにちは!RuiOkazakiです!
【CleanCode】読みやすいコードを書く技術シリーズの3章目です!
前回の記事をまだ読んでいない方は前回の記事から読んでいただけると更に理解が深まると思います!

  1. 導入編
  2. 命名規則編
  3. コメント編
  4. 変数の定義編


変数を定義する際に意識した方が良いこと

  • 変数が使える範囲を絞ることで変更範囲を制限することができる
  • 変数名で値や意図がわかるようにする
  • 読みやすく、検索しやすい名前にする


マジックナンバーを避ける

マジックナンバーとは、コンピュータプログラムのソースコードなどに直に記述された数値で、その意味や意図が記述した本人以外には自明ではないもの。

// 1.1が何の値かがわからない
console.log(5000 * 1.1);

// 1.1の値に意味をつけることで変更や意図がわかりやすい
const TAX = 1.1;
console.log(5000 * TAX);


// 3.14は何?
function calcArea(radius) {
  return 3.14 * radius * radius;
}

// 円周率Piを定義することでわかりやすい
const PI = 3.14;
function calcArea(radius) {
  return PI * radius * radius;
}


目的以外の情報を持たせない

変数名からはみ出る情報を入れてしまうと混乱を招くことになるのでやめましょう

// user idが格納されていると期待してしまう.実際は名前や年齢などの余分な情報が含まれている
const currentUserId = {
  id: 12,
  name: "田中",
  age: 20,
};

// UserIdとUserで格納する値が違うので分けている
const currentUserId = 12;
const currentUser = {
  id: 12,
  name: "田中",
  age: 20,
};


配列はindexで指定するより分割代入で明示的にする

const pattern = /[\/\.\-]/;
const date = "2002/02/06";
// splitDateの値が何を示しているかがわかりづらい
const splitDate = date.split(pattern);
console.log(`${splitDate[0]}年${splitDate[1]}月${splitDate[2]}日`);

// 分割代入で値に名前を付けることができる
const [year, month, day] = date.split(pattern);
console.log(`${year}年${month}月${day}日`);


1つの目的に1つの変数を定義する

const PI = 3.14;
// sizeが何を指す変数かがわかりません
let size = 30;
size = PI * size * size;
console.log(`円の面積は${size}です`);

// radiusが半径、circularAreaが面積
const radius = 30;
const circularArea = PI * radius * radius;
console.log(`円の面積は${circularArea}です`);


変数の寿命を短くする

※寿命とは宣言してから使用するまでの行数のこと

const currentUser = fetchUser();
// 100行の処理
// 宣言から離れすぎていて何が入っているのかがわかりづらい…見返すのが大変
if(currentUser.role = "admin") {
  // adminだった場合の処理
}


// 100行の処理
// 使用する直前で宣言することで中身が想像しやすく、バグが起きづらいコードになる
const currentUser = fetchUser();
if(currentUser.role = "admin") {
  // adminだった場合の処理
}


まとめ

今回は変数を宣言する際に気をつけた方がよいポイントを紹介していきました!
複数人で開発する際でも使った方が良いTipsばかりだったと思います!今後も記事を楽しみにしていただけると幸いです!

  • 初心者
  • JavaScript

おかざきるい

フロントエンド中心にコード書きます。邦ロックとアイスとカメラが好きです。

トップページへ戻る

こちらの記事もおすすめ

初心者がフロントエンドエンジニアとして全国2位になれた勉強法のサムネイル

2022.06.15

初心者がフロントエンドエンジニアとして全国2位になれた勉強法

おかざきるい

【時短したいあなたに!】MacBook に入れるべきアプリ 23選のサムネイル

2022.08.02

【時短したいあなたに!】MacBook に入れるべきアプリ 23選

おかざきるい

8の倍数と奇数のデザイン、8の倍数の方が圧倒的に便利だった件のサムネイル

2022.06.02

8の倍数と奇数のデザイン、8の倍数の方が圧倒的に便利だった件

きのしたゆうり