Clean Coding

𝗧𝗶𝗽𝘀 𝗳𝗼𝗿 𝗖𝗹𝗲𝗮𝗻 𝗖𝗼𝗱𝗲

When we code, we write it for others to read later on, not for ourselves. Even if a person is working on an individual project it’s crucial that your code is readable to another developer.

𝟭. 𝗔𝘃𝗼𝗶𝗱 𝗽𝗼𝗼𝗿 𝗻𝗮𝗺𝗶𝗻𝗴

Variables should be meaningful, reveal intention, and should be chosen from the problem domain

𝟮. 𝗙𝗼𝗹𝗹𝗼𝘄 𝗰𝗼𝗿𝗿𝗲𝗰𝘁 𝗻𝗮𝗺𝗶𝗻𝗴 𝗰𝗼𝗻𝘃𝗲𝗻𝘁𝗶𝗼𝗻𝘀

It’s important that you follow the correct naming convention to avoid being a chaotic coder. Be consistent with the casing.

𝟯. 𝗞𝗲𝗲𝗽 𝗳𝘂𝗻𝗰𝘁𝗶𝗼𝗻 𝗽𝗮𝗿𝗮𝗺𝗲𝘁𝗲𝗿 𝗰𝗼𝘂𝗻𝘁 𝘁𝗼 𝗮 𝗺𝗶𝗻𝗶𝗺𝘂𝗺

The best practice is to keep your method to 3 or fewer parameters. While it can become hard sometimes when you look closely there are situations where you can split the method into different functions.

𝟰. 𝗗𝗲𝗰𝗹𝗮𝗿𝗲 𝘃𝗮𝗿𝗶𝗮𝗯𝗹𝗲𝘀 𝗮𝘁 𝘁𝗵𝗲 𝗽𝗹𝗮𝗰𝗲 𝗼𝗳 𝘂𝘀𝗲

Variables should be declared at the place where they are actually being used. That way you won’t have to scroll back and forth to understand your code.

𝟱. 𝗔𝘃𝗼𝗶𝗱 𝘂𝘀𝗶𝗻𝗴 𝗰𝗼𝗻𝗳𝘂𝘀𝗶𝗻𝗴 𝗺𝗮𝗴𝗶𝗰 𝗻𝘂𝗺𝗯𝗲𝗿𝘀

If you are using numbers in if-else-if conditional statements, declare constants to explain their meaning. Also, you can create an enumeration if the value is being used at multiple places.

𝟲. 𝗠𝗶𝗻𝗶𝗺𝗶𝘇𝗲 𝗲𝘅𝘁𝗲𝗻𝘀𝗶𝘃𝗲 𝗻𝗲𝘀𝘁𝗲𝗱 𝗰𝗼𝗻𝗱𝗶𝘁𝗶𝗼𝗻𝘀

Multiple nested conditions make it hard to read your code. Always try to simplify them. Hint: use the switch statement or combine them using conditional operators.

𝟳. 𝗗𝗼𝗻’𝘁 𝗶𝗺𝗽𝗹𝗲𝗺𝗲𝗻𝘁 𝘀𝘂𝗽𝗲𝗿 𝗹𝗼𝗻𝗴 𝗳𝘂𝗻𝗰𝘁𝗶𝗼𝗻𝘀

The function should be short and do just 1 thing. Try to avoid creating long functions. Just because you can read it and understand that doesn’t mean it’s a good practice. Most of the time it’s hard to understand, change and reuse.

𝟴. 𝗔𝘃𝗼𝗶𝗱 𝗰𝗼𝗱𝗲 𝗱𝘂𝗽𝗹𝗶𝗰𝗮𝘁𝗶𝗼𝗻 Do you find yourself copy-pasting the same code to different places with small changes? Bad..Use the DRY principle instead

𝟵. 𝗠𝗮𝗸𝗲 𝗻𝗲𝗰𝗲𝘀𝘀𝗮𝗿𝘆 𝗰𝗼𝗺𝗺𝗲𝗻𝘁𝘀

Use your comments to explain the whys and hows. Never state the obvious using comments. Don’t keep dead code in comments, use version control