おかざきるい

こんにちは!RuiOkazakiです!
【CleanCode】読みやすいコードを書く技術シリーズの2章目です!
前回の記事をまだ読んでいない方は前回の記事から読んでいただけると更に理解が深まると思います!
例えば以下のコードを見てみましょう。
const a = 1200 / 60;このコードでは変数名が抽象的過ぎて、何をしているのか全く意図が伝わってきません。
const minutes = 1200;
const hours = minutes / 60;記述内容は同じですが変数に分け命名を意識し修正しました。
その結果変数名から分を時間に計算するという処理が汲み取れるようになりました!
今回のように名前を意識することで処理や値がわかりやすくなり、後続の処理を追わなくても使用用途が安易に想像できるようになります!
const calc = (n) => n / 60;何をする関数かわからない
const convertMinsToHours = (minutes) => minutes / 60;関数名を変更することで具体的な処理を読まなくてもある程度処理が想像できるようになりました。
が大切です。
命名規則とは、変数名などコンピュータプログラムのソースコード上で開発者が名付ける識別名についての決まりごと。言語仕様や開発環境などによって定められているものと、ソフトウェア開発を行う組織やチームが内部的に定めるものがある。
命名規則(ネーミング規約)とは - 意味をわかりやすく - IT用語辞典 e-Words より引用
単語間をハイフンで繋げます。
HTMLのclass名やURLに使用します。
kebab-case
user-id単語間をアンダーバーで繋げます。DBのテーブル名やphpなどの命名に使用します
snake_case
created_at
user_id単語間を大文字で繋げます。JavaScriptなどで使用します。
camelCase
getName
blogTitleJavaScriptでは原則キャメルケース、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,
};動詞(+形容詞+名詞)で命名するとわかりやすく命名出来ます。
const convertMinsToHours = (minutes) => {
return minutes / 60;
}const user = {
name: 'string',
age: 20,
printInfo(){},
}usernameではなくname、printUserInfoではなくprintInfoにすることで冗長な命名を避けることができる。
よくプログラミングでは先頭を除く母音を飛ばした命名をする人がいます。(index → idx)
有名なidxやfmtはプログラミングをしていれば出てくるので意味が伝わりますが、読み手が知らない場合があるので慣れない間は混乱を防ぐため避けた方が良いです。(一応短縮語検索サイトで調べることも出来ます。)
省略する際は上記に注意するようにしましょう!
a11y ⇆ accessibilityi18n ⇆ internationalizationinit ⇆ initializecalc ⇆ calculateidx ⇆ indexbtn ⇆ button
const users = [{},{}];
const userList = [{},{}];
const userArray = [{},{}];一見dataは単数系に見えdatasと命名してしまいそうになりますが、実はdatumの複数形なのです。
そもそもdata自体何を指しているものかわからないので使わないようにしましょう!
removeやdeleteなどの単語を同じ意味として使用している場合は命名を統一することで紛らわしさを無くすことができます。
const removeMenu = () => {};
const deleteNav = () => {};対義語を正しく使用することでわかりやすい命名をすることが出来ます。
next ⇆ prevcreate ⇆ deleteshow ⇆ hide
ご清覧ありがとうございました。
コメント編へ
おかざきるい
フロントエンド中心にコード書きます。邦ロックとアイスとカメラが好きです。
トップページへ戻る