Introduction

Welcome to your next step in mastering Clean Code! 🚀 Previously, we emphasized the significance of naming conventions in clean coding. Now, we delve into the realm of functions and methods, which serve as the backbone of application logic and are crucial for code organization and execution. Structuring these functions effectively is vital for enhancing the clarity and maintainability of a codebase. In this lesson, we'll explore best practices and techniques to ensure our code remains clean, efficient, and readable.

Clean Functions at a Glance

Let's outline the key principles for writing clean functions:

  • Keep functions small. Small functions are easier to read, comprehend, and maintain.
  • Focus on a single task. A function dedicated to one task is more reliable and simpler to debug.
  • Limit arguments to three or fewer. Excessive arguments complicate the function signature and make it difficult to understand and use.
  • Avoid boolean flags. Boolean flags can obscure the code's purpose; consider separate methods for different behaviors.
  • Eliminate side effects. Functions should avoid altering external states or depending on external changes to ensure predictability.
  • Implement the DRY principle. Employ helper functions to reuse code, minimizing redundancy and enhancing maintainability.

Now, let's take a closer look at each of these rules.

Keep Functions Small

Functions should remain small, and if they become too large, consider splitting them into multiple, focused functions. While there's no fixed rule on what counts as large, a common guideline is around 15 to 25 lines of code, often defined by team conventions.

Below, you can see the processOrder function which is manageable but has the potential to become unwieldy over time:

void processOrder(Order& order, Inventory& inventory, Logger& logger) {
    // Step 1: Validate the order
    if (!order.isValid()) {
        logger.log("Invalid Order");
        return;
    }

    // Step 2: Process payment
    if (!order.processPayment()) {
        logger.log("Payment failed");
        return;
    }

    // Step 3: Update inventory
    inventory.update(order.getItems());

    // Step 4: Notify customer
    order.notifyCustomer();

    // Step 5: Log order processing
    logger.log("Order processed successfully");
}

Given that this process involves multiple steps, it can be improved by extracting each step into a dedicated private function, as shown below:

void processOrder(Order& order, Inventory& inventory, Logger& logger) {
    if (!validateOrder(order, logger)) return;
    if (!processPayment(order, logger)) return;
    updateInventory(order, inventory);
    notifyCustomer(order);
    logOrderProcessing(logger);
}

bool validateOrder(Order& order, Logger& logger) {
    if (!order.isValid()) {
        logger.log("Invalid Order");
        return false;
    }
    return true;
}

bool processPayment(Order& order, Logger& logger) {
    if (!order.processPayment()) {
        logger.log("Payment failed");
        return false;
    }
    return true;
}

void updateInventory(Order& order, Inventory& inventory) {
    inventory.update(order.getItems());
}

void notifyCustomer(Order& order) {
    order.notifyCustomer();
}

void logOrderProcessing(Logger& logger) {
    logger.log("Order processed successfully");
}
Single Responsibility

A function should embody the principle of doing one thing only. If a function handles multiple responsibilities, it may include several logical sections. Below you can see the saveAndNotifyUser function, which is both too lengthy and does multiple different things at once:

void saveAndNotifyUser(User& user, DataSource& dataSource) {
    // Save user to the database
    const char* sql = "INSERT INTO users (name, email) VALUES (?, ?)";

    try {
        Connection connection = dataSource.getConnection();
        PreparedStatement statement = connection.prepareStatement(sql);
        // Set user details in the prepared statement
        statement.setString(1, user.getName().c_str());
        statement.setString(2, user.getEmail().c_str());

        // Execute the update query to save user
        statement.executeUpdate();
    } catch (SQLException &e) {
        std::cerr << "SQL exception: " << e.what() << std::endl; // Handle SQL exception
    }

    // Send a welcome email to the user
    webClientPost(user);
}

To enhance this code, you can create two dedicated functions for saving the user and sending the welcome email. This results in dedicated responsibilities for each function and clearer coordination:

void saveAndNotifyUser(User& user, DataSource& dataSource) {
    saveUser(user, dataSource);
    notifyUser(user);
}

void saveUser(User& user, DataSource& dataSource) {
    const char* sql = "INSERT INTO users (name, email) VALUES (?, ?)";

    try {
        Connection connection = dataSource.getConnection();
        PreparedStatement statement = connection.prepareStatement(sql);
        statement.setString(1, user.getName().c_str());
        statement.setString(2, user.getEmail().c_str());
        statement.executeUpdate();
    } catch (SQLException &e) {
        std::cerr << "SQL exception: " << e.what() << std::endl; // Handle SQL exception
    }
}

void notifyUser(User& user) {
    // Example logic to send email notification
    std::cout << "Sending welcome email to " << user.getName() << "..." << std::endl;
    // Email sending logic here
}
Limit Number of Arguments

Try to keep the number of function arguments to a maximum of three, as having too many can make functions less understandable and harder to use effectively. 🤔

Consider the saveAddress function below with five arguments, which makes the function less clean:

void saveAddress(std::string street, std::string city, std::string state, std::string zipCode, std::string country) {
    // Logic to save address
}

A cleaner version encapsulates the details into an Address object, reducing the number of arguments and making the function signature clearer:

void saveAddress(const Address& address) {
    // Logic to save address
}
Avoid Boolean Flags

Boolean flags in functions can create confusion, as they often suggest multiple pathways or behaviors within a single function. Instead, use separate methods for distinct behaviors. 🚫

The setFlag function below uses a boolean flag to indicate user status, leading to potential complexity:

void setFlag(User& user, bool isAdmin) {
    // Logic based on flag
}

A cleaner approach is to have distinct methods representing the different behaviors:

void grantAdminPrivileges(User& user) {
    // Logic for admin rights
}

void revokeAdminPrivileges(User& user) {
    // Logic to remove admin rights
}
Avoid Side Effects

A side effect occurs when a function modifies some state outside its scope or relies on something external. This can lead to unpredictable behavior and reduce code reliability.

Below, the addToTotal function demonstrates a side effect by modifying an external state:

// Not Clean - Side Effect
int addToTotal(int value) {
    total += value; // modifies external state
    return total;
}

A cleaner version, calculateTotal, performs the operation without altering any external state:

// Clean - No Side Effect 🌟
int calculateTotal(int initial, int value) {
    return initial + value;
}
Don't Repeat Yourself (DRY)

Avoid code repetition by introducing helper functions to reduce redundancy and improve maintainability.

The printUserInfo and printManagerInfo functions below repeat similar logic, violating the DRY principle:

void printUserInfo(const User& user) {
    std::cout << "Name: " << user.name << std::endl;
    std::cout << "Email: " << user.email << std::endl;
}

void printManagerInfo(const Manager& manager) {
    std::cout << "Name: " << manager.name << std::endl;
    std::cout << "Email: " << manager.email << std::endl;
}

To adhere to DRY principles, use a generalized printInfo function that operates on a parent Person type:

void printInfo(const Person& person) {
    std::cout << "Name: " << person.name << std::endl;
    std::cout << "Email: " << person.email << std::endl;
}
Summary

In this lesson, we learned that clean functions are key to maintaining readable and maintainable code. By keeping functions small, adhering to the Single Responsibility Principle, limiting arguments, avoiding side effects, and embracing the DRY principle, you set a strong foundation for clean coding. Next, we'll practice these principles to further sharpen your coding skills! 🎓

Previous
Next
Sign up
Join the 1M+ learners on CodeSignal
Be a part of our community of 1M+ users who develop and demonstrate their skills on CodeSignal