Apakah Kod Bersih dan Mengapa ia penting

Menulis kod yang hanya perlu digunakan sekali boleh dilakukan walau bagaimanapun anda mahu menulis. Tetapi, dalam kebanyakan kes, mematuhi amalan terbaik dan mengekalkan kod bersih adalah penting.

Ingat, kod anda mungkin akan dibaca oleh pembangun lain, atau anda sendiri, pada masa akan datang. Apabila tiba masanya, kod anda harus jelas. Setiap pembolehubah, fungsi dan ulasan hendaklah tepat, bersih dan mudah difahami. Pendekatan ini bukan sahaja memudahkan penyelenggaraan yang lebih mudah tetapi juga menggalakkan kerjasama dan kecekapan dalam pasukan pembangunan anda.

Jadi, apabila seseorang (atau anda) kembali untuk menambah atau mengubah suai kod anda, mudah untuk memahami perkara yang dilakukan oleh setiap baris kod. Jika tidak, kebanyakan masa anda akan dihabiskan hanya untuk cuba memahami kod tersebut. Isu yang sama akan timbul untuk pembangun baharu yang bekerja pada pangkalan kod anda. Mereka tidak akan memahami kod jika ia tidak bersih. Oleh itu, adalah sangat penting untuk menulis kod bersih.

Apakah Kod Bersih?

Kod bersih pada asasnya merujuk kepada kod iaitu

1. Mudah Difahami
2. Mudah untuk Nyahpepijat
3. Mudah Diselenggara
4. Komen ditulis dengan baik, pendek dan boleh difahami
5. Tiada kod pendua(Berlebihan) dan mengikut peraturan KISS (Simpan mudah, Bodoh!)

Dengan itu untuk menulis kod bersih pembangun perlu mengekalkan konsistensi dalam kod dan pembangun perlu mengikut amalan terbaik untuk bahasa tertentu.

Mengapa Kod Bersih adalah penting?

Apabila pasukan mengikut prinsip kod yang bersih, pangkalan kod menjadi lebih mudah untuk dibaca dan dinavigasi. Ini membantu pembangun memahami kod dengan cepat dan mula menyumbang. Berikut ialah beberapa sebab mengapa kod bersih penting.

1. Kebolehbacaan dan penyelenggaraan: Kod mudah dibaca dan difahami apabila ia ditulis dengan baik, mempunyai ulasan yang baik dan mengikut amalan terbaik. Sebaik sahaja isu atau pepijat datang, anda tahu di mana untuk mencarinya.

2. Penyahpepijatan: Kod bersih direka bentuk dengan kejelasan dan kesederhanaan, menjadikannya lebih mudah untuk mencari dan memahami bahagian tertentu pangkalan kod. Struktur yang jelas, nama pembolehubah yang bermakna dan fungsi yang jelas menjadikannya lebih mudah untuk mengenal pasti dan menyelesaikan isu.

3. Kualiti dan kebolehpercayaan yang dipertingkatkan: Kod bersih mengikut amalan terbaik bahasa tertentu dan mengutamakan kod berstruktur dengan baik. Ia menambah kualiti dan meningkatkan kebolehpercayaan. Jadi ia menghapuskan ralat yang mungkin disebabkan oleh kereta dan kod tidak berstruktur.

Sekarang kami memahami sebab kod bersih adalah penting, mari kita selami beberapa amalan dan prinsip terbaik untuk membantu anda menulis kod bersih.

---

Prinsip Kod Bersih

Untuk mencipta kod yang hebat, seseorang mesti mematuhi prinsip dan amalan kod bersih, seperti menggunakan kaedah yang kecil dan jelas.

Jom lihat ini secara terperinci.

1. Elakkan Nombor Berkod Keras

Daripada menggunakan nilai secara langsung, kita boleh menggunakan pemalar dan memberikan nilai itu kepadanya. Supaya pada masa hadapan jika kita perlu mengemas kini nilai itu kita perlu mengemas kininya di satu lokasi sahaja.

Contoh

function getDate() {
  const date = new Date();
  return "Today's date: " + date;
}

function getFormattedDate() {
  const date = new Date().toLocaleString();
  return "Today's date: " + date;
}

Dalam kod ini, pada satu ketika terdapat perubahan yang bukannya "Tarikh hari ini: " perlu menjadi "Tarikh: ". Ini boleh diperbaiki dengan memberikan rentetan itu kepada satu pembolehubah.

Kod yang dipertingkatkan:

const todaysDateLabel = "Today's date: ";

function getDate() {
  const date = new Date();
  return todaysDateLabel + date;
}

function getFormattedDate() {
  const date = new Date().toLocaleString();
  return todaysDateLabel + date;
}

Dalam kod di atas menjadi mudah untuk menukar rentetan tarikh apabila diperlukan. Ia meningkatkan kebolehselenggaraan.

2. Gunakan Nama Bermakna dan Deskriptif
Daripada menggunakan nama pembolehubah biasa di mana-mana, kita boleh menggunakan lebih sedikit nama deskriptif yang menerangkan sendiri. Nama pembolehubah itu sendiri harus menentukan penggunaannya.

Peraturan nama

1. Pilih nama deskriptif dan tidak jelas.
2. Buat perbezaan yang bermakna.
3. Gunakan nama yang boleh disebut.
4. Gunakan nama yang boleh dicari.
5. Gantikan nombor ajaib dengan pemalar bernama.
6. Elakkan pengekodan. Jangan tambahkan awalan atau taip maklumat.

Contoh

// Calculate the area of a rectangle
function calc(w, h) {
    return w * h;
}

const w = 5;
const h = 10;
const a = calc(w, h);
console.log(`Area: ${a}`);

Di sini kod adalah betul tetapi terdapat beberapa kekaburan dalam kod. Mari lihat kod di mana nama deskriptif digunakan.

Kod yang dipertingkatkan

// Calculate the area of a rectangle
function calculateRectangleArea(width, height) {
    return width * height;
}

const rectangleWidth = 5;
const rectangleHeight = 10;
const area = calculateRectangleArea(rectangleWidth, rectangleHeight);
console.log(`Area of the rectangle: ${area}`);

Di sini setiap nama pembolehubah adalah penjelasan sendiri. Jadi, ia adalah mudah untuk memahami kod dan ia meningkatkan kualiti kod.

3. Hanya gunakan komen di mana perlu
Anda tidak perlu menulis komen di mana-mana. Tulis sahaja di mana perlu dan tulis dengan ringkas dan mudah difahami. Terlalu banyak komen akan membawa kepada kekeliruan dan pangkalan kod yang tidak kemas.

Peraturan ulasan

1. Always try to explain yourself in code.
2. Don't be redundant.
3. Don't add obvious noise.
4. Don't use closing brace comments.
5. Don't comment out code. Just remove.
6. Use as explanation of intent.
7. Use as clarification of code.
8. Use as warning of consequences.

Example

// Function to get the square of a number
function square(n) {
    // Multiply the number by itself
    var result = n * n; // Calculate square
    // Return the result
    return result; // Done
}

var num = 4; // Number to square
var squared = square(num); // Call function

// Output the result
console.log(squared); // Print squared number

Here we can see comments are used to define steps which be easily understand by reading the code. This comments are unnecessary and making code cluttered. Let's see correct use of comments.

Improved code

/**
 * Returns the square of a number.
 * @param {number} n - The number to be squared.
 * @return {number} The square of the input number.
 */
function square(n) {
    return n * n;
}

var num = 4;
var squared = square(num); // Get the square of num

console.log(squared); // Output the result

In above example comments are used only where it is needed. This is good practice to make your code clean.

4. Write Functions That Do Only One Thing
When you write functions, don't add too many responsibilities to them. Follow the Single Responsibility Principle (SRP). This makes the function easier to understand and simplifies writing unit tests for it.

Functions rules

1. Keep it Small.
2. Do one thing.
3. Use descriptive names.
4. Prefer fewer arguments.
5. Split method into several independent methods that can be called from the client.

Example

async function fetchDataAndProcess(url) {
    // Fetches data from an API and processes it in the same function
    try {
        const response = await fetch(url);
        const data = await response.json();

        // Process data (e.g., filter items with value greater than 10)
        const processedData = data.filter(item => item.value > 10);

        console.log(processedData);
    } catch (error) {
        console.error('Error:', error);
    }
}

// Usage
const apiUrl = 'https://api.example.com/data';
fetchDataAndProcess(apiUrl);

In the above example, we can see a function that fetches data using an API and processes it. This can be done by another function. Currently, the data processing function is very small, but in a production-level project, data processing can be very complex. At that time, it is not a good practice to keep this in the same function. This will make your code complex and hard to understand in one go.
Let's see the clean version of this.

Improved code

async function fetchData(url) {
    // Fetches data from an API
    try {
        const response = await fetch(url);
        return await response.json();
    } catch (error) {
        console.error('Error:', error);
        throw error;
    }
}

function processData(data) {
    // Processes the fetched data (e.g., filter items with value greater than 10)
    return data.filter(item => item.value > 10);
}

// Usage
const apiUrl = 'https://api.example.com/data';

fetchData(apiUrl)
    .then(data => {
        const processedData = processData(data);
        console.log(processedData);
    })
    .catch(error => {
        console.error('Error:', error);
    });

In the this example, the responsibilities are separated: the fetchData function handles the API call, and the processData function handles data processing. This makes the code easier to understand, maintain, and test.

5. Avoid Code Duplication (Follow DRY Principle - Don't Repeat Your Self)

To enhance code maintainability and cleanliness, strive to create reusable functions or reuse existing code whenever possible. For instance, if you are fetching data from an API to display on a page, you would write a function that retrieves the data and passes it to a renderer for UI display. If the same data needs to be shown on another page, instead of writing the same function again, you should move the function to a utility file. This allows you to import and use the function in both instances, promoting reusability and consistency across your codebase.

Other General Rules for writing Clean Code

• Follow standard conventions(For JavaScript Camel Case).
• Keep it simple stupid. Simpler is always better. Reduce complexity as much as possible.
• Boy scout rule. Leave the campground cleaner than you found it.
• Always find root cause. Always look for the root cause of a problem.
• Write code which is easy to understand

Implement this Practices and Principles from today to write Clean Code.

Atas ialah kandungan terperinci Apakah Kod Bersih dan Mengapa ia penting. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!