きれいなコードを書く方法

なぜきれいなコードを書くのか? ⛩️

散らかった部屋で何かを見つけようとした場合を想像してみてください。探すのに時間を無駄にしてしまいますよね。

乱雑なコードにも同じことが当てはまります!問題を見つけたり、何が起こっているのかを理解するのはさらに困難になります。クリーンなコードを使用すれば、そのような混乱を避けることができます。

ご存知ですか?. クリーンなコードを書くことで、他の開発者の貴重な時間を節約することもできます。信じてください...あなたは世界を救っています! ?

---

きれいなコードを書くための 7 つのヒント?

1. 意味のある名前を使用する

変数または関数を作成するときは、その機能がわかる名前を付けます。

これは、コンピューター上のフォルダーに名前を付けるようなものだと考えてください。これを b と呼ぶ代わりに、numberOfUsers と呼びます。こうすることで、b が何であるかを説明するために余分なコメントは必要なくなります。

例:

let numberOfUsers = 5; // Clear and easy to understand

2. 単一責任原則 (SRP) に従う

関数は 1 つのジョブを適切に実行する必要があります。

これにより、必要に応じて理解し、修正することが容易になります。書くための鉛筆と切るためのハサミのように、1 つの作業に対して 1 つのツールを使用するようなものです。

例:

function addNumbers(a, b) {
    return a + b;
}

この関数は 2 つの数値を加算するだけです。他には何もしません。

3. 不必要なコメントを避ける

どこにでもコメントを追加するのではなく、適切な名前を使用して、コードが一目瞭然になるようにしてください。

コメントは、扱いにくい場合や特別な注意が必要な場合にのみ使用してください。コメントが多すぎると人々が混乱する可能性があります。 ??

例:

// Good: Clear name, no extra comment needed
let userAge = 25; 

// Bad: Unclear name, needs a comment
let a; // age of the user

4. コードを読みやすくする

コードをきれいに保つために、スペース、インデント、および 改行を使用してください。

段落を書くのと同じように、コードを小さな部分に分割して、すべてが 1 行にならないようにする必要があります。

例:

// Good Code
if (isLoggedIn) {
    console.log("Welcome!");
} else {
    console.log("Please log in.");
}

// Bad Code
if(isLoggedIn){console.log("Welcome!");}else{console.log("Please log in.");}

5. 単体テストを作成する

単体テストはコードのチェックアップです。

彼らは、すべてが正常に機能することを確認します。コードを変更すると、これらのテストにより、何かが壊れているかどうかがわかります。

例:

function add(a, b) {
    return a + b;
}

// Test
console.assert(add(2, 3) === 5, 'Test failed: 2 + 3 should be 5');

6. 依存関係に注意する

ソフトウェアを構築するときは、相互に依存しすぎないように、複数のものを分離するようにしてください。

たとえば、食器洗い機は、特定のキッチンだけでなく、どのキッチンにも設置できます。その方が管理が簡単です。

7. プロジェクトを整理する

机をきれいに保つのと同じように、ファイルやフォルダーを整理してください。これにより、プロジェクトが大きくなったときに、探しやすくなります。

例:

• プロジェクト内でコンポーネント、サービス、ユーティリティなどのフォルダーを使用します。
• どこで探せばよいかわかるように、類似したファイルをまとめて保管してください。

✅ おすすめ

この印刷可能なバックエンド開発者概念テンプレートを使用して、進捗状況を追跡してください。 ?

初心者の開発者は、適切な技術スタックの選択に苦労することが多く、時間の無駄やモチベーションの低下につながります。

そこで、私は Notion で美しくデザインされた非常にわかりやすい 6 か月のバックエンド開発者ロードマップを作成しました。これにより、進捗状況を追跡し、簡単に目標を達成できるようになります。

このロードマップ:

• ?️ 混乱を避けるための明確な道筋を示します。
• ?どこから始めてどこで終了するかを概説することで、モチベーションを維持するのに役立ちます。
• ?学校のカリキュラムと同様に、構造化された計画に従います。
• ?ツールと言語の週ごとの目標を設定して学習を整理します。
• ⏳ 必要なすべてを網羅し、6 か月以内に完了します。
• ?ナビゲーションが簡単な美しいデザインが特徴です。

---

結論 ？

きれいなコードを書くことは、家の強力な基礎を築くことに似ています。すべてが整理整頓されているため、新しいものを追加したり、問題を修正したりすることが簡単にできます。

これらの 7 つのヒントに従って、コードをシンプルで読みやすく、扱いやすいものにしてください。

続きを読む: 6 か月でバックエンド開発者になるためのスキル (ロードマップ)

以上がきれいなコードを書く方法の詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。