2022.10.12

【CleanCode】より良いコードを書く技術(命名規則編) ②

おかざきるい

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

  1. 導入編
  2. 命名規則編( ← 現在のページ )
  3. コメント編


なぜ変数名が大切なのか

例えば以下のコードを見てみましょう。

const a = 1200 / 60;

このコードでは変数名が抽象的過ぎて、何をしているのか全く意図が伝わってきません。

const minutes = 1200;
const hours = minutes / 60;

記述内容は同じですが変数に分け命名を意識し修正しました。
その結果変数名から分を時間に計算するという処理が汲み取れるようになりました!
今回のように名前を意識することで処理や値がわかりやすくなり、後続の処理を追わなくても使用用途が安易に想像できるようになります!

例

const calc = (n) => n / 60;

何をする関数かわからない

const convertMinsToHours = (minutes) => minutes / 60;

関数名を変更することで具体的な処理を読まなくてもある程度処理が想像できるようになりました。

良い変数名とは?

  • 曖昧すぎない
  • 短すぎず長すぎない
  • 処理や値を説明できている

が大切です。

命名規則(case)

命名規則とは、変数名などコンピュータプログラムのソースコード上で開発者が名付ける識別名についての決まりごと。言語仕様や開発環境などによって定められているものと、ソフトウェア開発を行う組織やチームが内部的に定めるものがある。
命名規則(ネーミング規約)とは - 意味をわかりやすく - IT用語辞典 e-Words より引用

ケバブケース

単語間をハイフンで繋げます。
HTMLのclass名やURLに使用します。

kebab-case
user-id

スネークケース

単語間をアンダーバーで繋げます。
DBのテーブル名やphpなどの命名に使用します

snake_case
created_at
user_id

キャメルケース

単語間を大文字で繋げます。
JavaScriptなどで使用します。

camelCase
getName
blogTitle


変数の命名規則

JavaScriptでは原則キャメルケース、htmlのクラス名ではケバブケースを使用しましょう!
各言語によってスネークケースが推奨されている言語などもあるのでその都度調べましょう!
(形容詞+)名詞で命名するとわかりやすく命名出来きます。

const userId = getUserId();
const blogTitle = blog.title;


真偽値の命名規則

is~,can~などで始めることで真偽値の値が格納されるとわかります。

let isChecked = false;
let canRemove = false;


定数の命名規則

定数はアッパースネークケースかキャメルケースを使いましょう。
※ここで言う定数は再代入できない値のことを指します。
JavaScriptのconstは実際には定数ではないのでわかるように命名しましょう!

const TO_MICRO_SEC = { // toMicroSec でもOK
  ms: 1,
  second: 1000,
  minute: 1000 * 60,
  hour: 1000 * 60 * 60,
  day: 1000 * 60 * 60 * 24,
};

定数として使用しがちな値

  • URLのパス名
  • MAXの値


関数の命名規則

動詞(+形容詞+名詞)で命名するとわかりやすく命名出来ます。

const convertMinsToHours = (minutes) => {
  return minutes / 60;
}


オブジェクトやクラスのプロパティ / メソッドは冗長な名前にしない

const user = {
  name: 'string',
  age: 20,
  printInfo(){},
}

usernameではなくname、printUserInfoではなくprintInfoにすることで冗長な命名を避けることができる。

意味があり発音可能な名前にする

よくプログラミングでは先頭を除く母音を飛ばした命名をする人がいます。(index → idx)
有名なidxやfmtはプログラミングをしていれば出てくるので意味が伝わりますが、読み手が知らない場合があるので慣れない間は混乱を防ぐため避けた方が良いです。(一応短縮語検索サイトで調べることも出来ます。)

省略する場合のコツ

  • 標準の略語を使用
  • 一般的に使用されている
  • 辞書に載っている
  • エンジニアが使用するのパブリックな略語

省略する際は上記に注意するようにしましょう!

例

a11y ⇆ accessibility
i18n ⇆ internationalization
init ⇆ initialize
calc ⇆ calculate
idx ⇆ index
btn ⇆ button

配列の変数名は複数形にする / 配列というのがわかるような名前にする

const users = [{},{}];
const userList = [{},{}];
const userArray = [{},{}];


Dataという命名は避けるようにする

一見dataは単数系に見えdatasと命名してしまいそうになりますが、実はdatumの複数形なのです。
そもそもdata自体何を指しているものかわからないので使わないようにしましょう!

単語を統一する

removeやdeleteなどの単語を同じ意味として使用している場合は命名を統一することで紛らわしさを無くすことができます。

const removeMenu = () => {};
const deleteNav = () => {};


反対の意味を指す場合は対義語を使用する

対義語を正しく使用することでわかりやすい命名をすることが出来ます。

例

next ⇆ prev
create ⇆ delete
show ⇆ hide

まとめ

ご清覧ありがとうございました。
コメント編へ

  • 初心者
  • JavaScript

おかざきるい

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

トップページへ戻る

こちらの記事もおすすめ

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

2022.06.02

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

きのしたゆうり

【初心者向け】ロゴデザインで抑えておきたい3つのポイントのサムネイル

2022.06.08

【初心者向け】ロゴデザインで抑えておきたい3つのポイント

さとうまなみ

【色彩検定の勉強に】色はなぜ見えるのか?のサムネイル

2022.06.02

【色彩検定の勉強に】色はなぜ見えるのか?

こばやしたいよう