DEV Community

Cover image for Writing code that is clean and code that inspires
Matthew Rungwe
Matthew Rungwe

Posted on

Writing code that is clean and code that inspires

So, finally, you now know how to write code or you have been doing it for a while but do you still feel like you could be doing more? A good place to start will be to go through your projects and take a closer look at the code that you have written and see if you can make it better.

In this article, we are going to look at a few ways that can help you to start writing not only code that is clean but also code that inspires. I hope that after this read, you will be able to have a different mindset, approach in the way to structure your files and also have a few ideas of where to begin with the process.

Table of Contents

  1. Change your mindset
  2. Use comments
  3. Separate concerns
  4. Follow best practices
  5. Refactor whenever you can
  6. Use descriptive variable names
  7. Be consistent in your style
  8. Learn from others
  9. Learn to read the documentation
  10. Review your own code

Change your mindset

At some point in your journey, you will be in a position to share your work. For some, it may be sooner while for others even a little later in their career. Carry the mindset that you are not just writing for yourself, but rather the ides that you are writing for others. So, keep in mind that one day someone will go through your work. I also believe you would love to see a smile on their face and a nod of respect.

Use comments

Simple right? Then why do we forget to do it? The beauty of writing comments sometimes it's not just for the next person, it's actually for yourself.

Sometimes I find myself taking hours just to understand the code I wrote a few weeks or months back. You can quickly become a stranger to your own code. Now think, if you sometimes struggle with this, how about handing over a file like that to a colleague, a friend or a mentee. They would be disappointed if not hurt by the time they will need to spend just to understand the meaning of code you wrote.

Separate concerns

If you have been coding for at least a few weeks, I am sure you have asked yourself if there maybe another way to organize your code. It is important to separate functionality in the application that you are developing. As your application gets bigger and more complex, you need to be able to maintain it and there is no better way than to isolate each feature of the application into separate files. Guys in Computer Science will call this a loosely coupled system.

This idea can be as simple as writing HTML in it's own HTML file and writing JavaScript in it's own JavaScript file just so there will be a little order in your code. It can get as complicated writing your own API or base code that will depend heavily on modules that will communicate using import statements.

Follow Best Practices

Best practices are standard approaches that have been proven to produce effective results. These techniques (ways of doing things) are not there to guard you from being unique or creative but rather guide you towards developing systems that don't fall too far off from the standard scale.

The other beauty of best practices is that there will always be a lot of resources out there to assist you in solving the problems you come across during development or maintenance.

Refactor whenever you can

In addition to best practices, refactor as you go because you might not have enough time to come back and redo your code especially when you are working on a tight deadline.

In JavaScript, there were so many features that came with ES6 alone: arrow functions, template literals, ternary statements, symbols, de-structuring just to mention a few. In HTML we can now use semantic HTML elements which can even substitute a lot of ARIA attributes to improve accessibility.

Not only do these features simplify your code, you can also see a reduction in your file sizes which may not seem important in development but may very well play a role in the performance of your application in production.

Use descriptive variable names

Really Matthew? YES. I was part of the MWS Mentor Team for the Google Africa Developer Scholarship 2020 and had the privilege to review some of the projects submitted by students during the second phase. Some of the students would use variables like t for temperature and hu for humidity because they were building a Weather Web App. While to them it made clear sense but to others, it was painful process trying to understand what they were looking at.

Use variables that are meaningful and that describe the purpose they have been created for. Try not to use single letter variable names like xor y unless you are actually dealing with or referring to axes.

Be consistent in your style

As much as we want our code to look the same, it's a little hard. We all have a signature in our code, our way of doing things we say. Well, pick up a style and stick to it. If you prefer to have loosely defined variables or have them tied to an object, it's okay. However, try to maintain that approach through out your projects.


// Loosely defined variables
let courseName = `Beginner's guide to Web Development`;
let courseRating = 4.5;

// Using objects
let course = {
    name: `Beginner's guide to Web Development`,
    rating: 4.5
Enter fullscreen mode Exit fullscreen mode

Consistency may range from the code that you actually write to the architecture and technologies. If you are using a SASS as your CSS preprocessor try to hold to it throughout and not add LESS in the process.

Learn from others

As much as we don't want to admit it, there are some people that know how to do things better maybe because they have more experience or they may have spent a lot of time perfecting their technique and researching.

I improved my files structure by observing others mostly Angular folders generated by the CLI and HTML5 Up projects. I learnt how to organize my Data, Services and Interfaces from Deborah Kurata's code files on Pluralsight.

Sometimes, the way others do it just works. Don't wait too long to figure it out on your own when someone can save you all the time by learning from them.

Learn to read the documentation

This one is an interesting one. I was quite surprised when this idea popped up in my mind when I was planning this article. I am guilty of not spending enough time in the documentation of the technologies I use but it's something I am working on and I thought it would be nice to share anyway.

Reading the documentation allows you to stay up-to-date with the advancements in the technologies that you are using. You can adopt these improvements into your projects to save yourself from any vulnerabilities and to stay at the top of your game with you projects or your content.

I was inspired by Lea Verou, Deborah Kurata, John Papa and Brad Traversy from my courses on Pluralsight. They also happen to be experts in the Web Development industry.

Review your own code

It always amazes me how much changes I make when when I just dedicate a few hours to go through what I have written. Take a closer look at the code you have written and question yourself, "is there another way you could have written this?" or "are you sure there aren't any mistakes or misconceptions?"

It's always a good thing to go through your code again. You will always find some changes to make: it might be a comment to add or a better way to implement a function. This idea does not have to be independent to code alone, it can also apply to other aspects of life. Just take some time to go through what you do again and you will be amazed at the improvements you can make.

Writing code that inspires can take some time to be good at but it is not impossible. Try each time to improve the way you write your code and eventually you will get there because you can only get better if you try.

In summary, write you code as though you are writing it for a team and that it might potentially be a big thing tomorrow

Feel free to to leave a comment. Thank you for reading.

Top comments (0)