おかざきるい

こんにちは!RuiOkazakiです!
【CleanCode】読みやすいコードを書く技術シリーズの3章目です!
前回の記事をまだ読んでいない方は前回の記事から読んでいただけると更に理解が深まると思います!
コードで意図が全て伝えることができるのならコメントは要りません。
さらに言うと、「情報も持たないコメント」「誤情報を含むコメント」は邪魔にしかならないため「価値のあるコメント」を心がけましょう。
コメントを残すのではなく、関数名をわかりやすくすることでコメントを読まなくてもどう言う処理が行われるかがわかるようになる。
// 未成年ならtrueを返す
const getBoolean = (num) => {
return num < 18;
}
const isNotAdult = (age) => {
return age < 18;
}コメントを読むのにも時間がかかるため、コードから読み取れる情報を書いてしまうと冗長になってしまいます。
// ユーザーの性別が男性の場合処理を行う
const GENDER = {
male: 'male',
female: 'female',
nonbinary: 'nonbinary'`
}
if(user.gender === GENDER.male) {}ユーザーの性別と性別を格納しているenumを比較しているのが直感的に理解することが出来る。
// TODO: Promise.all に置き換えることができるかも
for (let i = 0; i <= 3; i++) {
new Promise((resolve, reject) => {
resolve(result);
});
}TODOコメントは実装漏れを防いだり、意図を書き残す有効的な手段なので実装中に懸念点なのがある場合は積極的に使用していきましょう!
/**
* @param {"ja" | "en" | "fr" } lang
* @returns {string}
*/
function getGreeting(lang) {
return greetings[lang];
}こちらはJSDocというコメントの残し方です。
関数や変数の宣言の直前に/* ◯◯ /を書く記法のことで、関数や変数の使い方などをエディター単位でサポートしてくれるようになります!
上記のコメントを残した場合は下記のように表示されます。
Google JavaScript スタイルガイドでも採用されている記述方法でドキュメントを自動生成することなどもできるのでOSSなどを開発する際やチームで開発する際は使用を検討してはいかがでしょうか!
// 20代男性、技術職、年収200万円以上、大阪府なら true
if (
20 <= age &&
age <= 29 &&
occupation === 1 &&
200 <= salary &&
prefecture === "osaka"
) {
return true;
}
return false;一見わかり辛いif文の中身をコメントで書き残していて良いコードだと考えられがちですが将来条件を変更する際にどの比較演算子が何の値を指しているかがわかりません。
また、コメントが最新とは限らずメンテナンスされていない可能性があるので変数名にすることで条件を変更する際などにも分かりやすくなります。
const isTwenties = 20 <= age && age <= 29;
const isTechnicalJob = occupation === 1;
const isSecondsMillionYenOrMore = (salary) => 200 <= salary;
const livingInOsaka = prefecture === "osaka";
const isTarget = ({ salary }) => isThirties && isTechnicalJob && isSecondsMillionYenOrMore(salary) && livingInTokyo;
if (isTarget({ salary })) {
return true;
}
return false;変数に格納することで条件式が何を現しているかがすぐわかりif文がごちゃごちゃせずにシンプルに書くことができます。
コメントは嘘を付く場合がありますがコードは嘘をつかないので複雑な条件式を扱う場合は積極的に使用しましょう!!
ご清覧ありがとうございました!
変数の定義へ
おかざきるい
フロントエンド中心にコード書きます。邦ロックとアイスとカメラが好きです。
トップページへ戻る