Code Smell - Hanlon&#s Razor

Don’t Overcomplicate: Keep It Simple

TL;DR: Overdefensive code leads to unnecessary complexity.

Problems

• Unnecessary complexity

• Confusing logic

• Hidden bugs

• Harder maintenance

• Slower performance

• Cluttered Code

Solutions

1. Simplify checks

2. Trust your logic

3. Focus on essentials

4. Follow the K.I.S.S. principle

5. Refactor regularly

Context

Overthinking and overdesigning your code can lead to unnecessary complexity.

You might need to defend against every possible scenario, but this approach often produces bloated, confusing code.

Hanlon's Razor suggests that you should not assume malice when simple mistakes or misunderstandings are more likely.

Avoid overly defensive programming and focus on clear, straightforward logic.

You might anticipate future problems that might never happen or try to make your code too flexible.

Simple code is easier to maintain, debug, and understand.

Sample Code

Wrong

function processData(data) {
    if (typeof data === 'undefined') {
        throw new Error('Data is undefined');
    }

    if (typeof data !== 'object') {
        throw new Error('Data is not an object');
    }

    if (data === null) {
        throw new Error('Data is null');
    }

    if (Array.isArray(data)) {
        throw new Error('Data should not be an array');
    }

    if (!data.hasOwnProperty('items')) {
        return [];
    }

    if (!Array.isArray(data.items)) {
        throw new Error('Items should be an array');
    }

    if (data.items.length === 0) {
        return []; 
    }

    let processedItems = [];
    for (let item of data.items) {
        if (typeof item === 'undefined') {
            continue; // Skip undefined items
        }

        if (typeof item !== 'object') {
            continue; // Skip non-object items
        }

        if (item === null) {
            continue; // Skip null items
        }

        processedItems.push(processItem(item));
    }

    return processedItems;
}

Right

function processData(data) {
    if (!Array.isArray(data.items)) {
        throw new Error('Invalid data');
    }

    return data.items
        .filter(item => typeof item === 'object' && item !== null)
        .map(item => processItem(item));
}

Detection

[X] Manual

Complicated code usually has more lines and long methods are a possible hint.

Tags

• Bloaters

Level

[x] Intermediate

AI Generation

AI generators can introduce this smell when they try to account for every possible edge case.

For example, dealing with NULLs is unnecessary if you completely avoid them.

AI Detection

AI tools can help detect overly defensive code by analyzing the logic and suggesting simplifications with proper guidance.

These tools often recommend removing unnecessary checks or combining them for clarity.

Conclusion

Avoid overthinking and overdesigning your code.

Focus on the most likely scenarios and write clear, straightforward logic.

Simplicity leads to better code quality and easier maintenance.

Relations

Code Smell 149 - Optional Chaining

Maxi Contieri ・ Jul 16 '22

#javascript #webdev #beginners #programming

Code Smell 12 - Null

Maxi Contieri ・ Oct 31 '20

#codenewbie #tutorial #oop

More Info

Wikipedia

Defensive Programming

Disclaimer

Code Smells are my opinion.

Credits

Photo by Nacho Fernández on Unsplash

Simplicity is the ultimate sophistication.

Leonardo da Vinci

Software Engineering Great Quotes

Maxi Contieri ・ Dec 28 '20

#codenewbie #programming #quotes #software

This article is part of the CodeSmell Series.

How to Find the Stinky parts of your Code

Maxi Contieri ・ May 21 '21

#codenewbie #tutorial #codequality #beginners

The above is the detailed content of Code Smell - Hanlon&#s Razor. For more information, please follow other related articles on the PHP Chinese website!