Skip to main content

How to write good code?

How To Write Good Code?

At some point of time we all hate reading other people code. Am I Right?

Because we think it's is not human readable, not debugging friendly, not clear comments, no clean log statements, clumsy code, not proper naming patterns followed, irregular function calls, repetitive lines of code, no OOPS concepts is utilized, etc...

✓ But if we ask the questions ourselves, are we writing really a good code?
✓ What if other developer think our code is bad? Ever thought about this?

If not, let's start from today to see if we are really writing good code.

So what is good code? 📑

1. Proper naming patterns should be followed.

2. Proper comments section can be added inline.

3. Avoid repetitive lines of code.

4. Make modular in nature.

5. Avoid writing big lines of code to just show, you know that programming language better than others.

6. Avoid using complex patterns, if simple 'if-else' can solve the problem then why to go for complex 'conditional expressions'.

7. Make import statements clear and include only required imports not all that you know.

8. Use try-catch block while writing code always.

9. See if you have any notification systems, try incorporate in your code and notify for any failure in the code to the team/developers.

10. If possible and use case suits OOPS concepts, just go for it.

11. Write a code in such a way that after 10 years too, people should wonder about you, how this developer written such a clean code and running for a decade without major hiccups.

12. Just keep in mind your print or console or log statement should say the clear story of your code execution.

13. Last but not least, your code should not only complier readable it should be human readable.
Remember that anyone can write a code to get outputs by satisfying language complier, but its always good to make our human satisfy by reading your code
✓ Above things are purely mentioned based on my experience with coding, enhancing other people code, reviewing the big code, debugging others code for hours, etc. Hope you will also agreeing with me and like to see the above standards in someone's code to makes our human developer life easier✍️.


Stay tuned, until next time✍️

Bye!

Comments

Popular posts from this blog

BIG DATA ANALYTICS

BIG DATA ANALYTICS Have you ever hit upon how Amazon and Flip kart could possible verdict what we want; how the Google auto completes our search; how the YouTube looks into videos we want to watch? When we open YouTube, we will be at sixes and sevens, when we find ads related to what we have searched earlier in the past days. This is where we find ourselves in the era of big data analytics. More than 3 trillion bytes of information are being generated everyday through our smart phones, tablets, GPS devices, etc.  Have we thought about what can be done with all these information? This is where the data analytics comes into play. Big data analytics is just the study of future build up to store data in order to extract the behaviour patterns. The entire social networking website gathers our data which are related to our interest which is usually done by using our past search or any other social information. Data analytics will lead to a walkover in near future....

Hidden things About Amazon SageMaker Studio

Did you know about Amazon SageMaker Studio❓ 🤔 Like you, I initially believed that this service was only for data-related tasks and that regular engineers/developers weren't supposed to use it. ✒️ However, after using it for a while, I would suggest that it can help you with more than just data related tasks. In fact, an organization can use SageMaker Studio to bring their entire SDLC 💪. 😬 Because of its data'ish ness like gimick we (normal non-data developers) always felt, "Oh, SageMaker, it's expensive 😱 so no, no don't go that side 🤐." 😷 As a result, we shrank and missed the hidden gem 💎 and its possibilities, as well as the opportunity to utilize such a fantastic and powerful tool 🔥. ✒️ Let me give you some glimpse with a preview of what SageMaker Studio is capable of. ✒️ SageMaker is big service, but in this post am limiting my context towards SageMaker Studio only. ✒️ And mostly, this write-up is for developers who enjoy writin...

A Conversation between Simba and Mufasa about AI

A Conversation between Simba 🐯 & Mufasa 🦁  about AI (Artificial Intelligence) Simba: Dad, have you heard about this thing called AI? Mufasa: Yes, my son. It’s a tool that can help us in many ways. Simba: But what if it takes over everything? What if one day, all the animals in the Pride Lands start asking AI to do their jobs? Mufasa: Simba, remember that while AI can assist us, it cannot replace the heart and spirit of the Circle of Life. Simba: So, you’re saying I shouldn’t worry? Mufasa: Exactly. Embrace AI as a friend, not a foe. It can help you hunt for ideas, but it can’t replace your instincts or your roar! Simba: So, I can still be the king, even with AI around? Mufasa: Of course! Just remember, the true strength of a king lies in his ability to adapt and grow, not just in what tools he uses. Simba: Thanks, Dad! I guess I’ll just have to learn to work with AI instead of worrying about it! Mufasa: That’s the spirit, my son. Now, let’s go find some lunch—AI can’t help ...