Make Spaghetti Code look Appetizing

19 Sep 2023

Introduction

If you have never heard of the term “spaghetti code,” it refers to code that is difficult to understand due to not having a defined structure or way of writing. It can be confusing and frustrating for people to read, almost like an essay with no headers, transitions, or punctuation. To avoid this problem, software engineers usually have coding standards that specify the rules and guidelines for writing code. For instance, a standard for writing in JavaScript may suggest that strings should have single quotation marks rather than double quotation marks (i.e. 'example of string' instead of "example of string"). There are possibly many different coding standards, but they all serve to keep code organized and consistent.

Why would I bother with coding standards if I am just coding for myself?

Other than making code more legible, following coding standards can provide advantages such as practicing good coding habits. Using the AirBnB JavaScript Style Guide as an example, one of the things that the guide recommends is to use const instead of var for all references (Link to that section in the guide). As mentioned in the style guide, const prevents the variable from being reassigned intentionally or mistakenly when coding. If the variable’s value must change, it suggests using let instead.

As mentioned before, the coding standards outlined in the style guide are not the only way to write JavaScript. You could follow coding standards from multiple guides, assuming they pertain to the same programming language. Alternatively, you could even make up your own rules for writing code. However, coding standards are essential when collaborating with other software engineers since they ensure a “common look.” If one collaborator decides to check someone else’s code for bugs, they are able to easily understand where things are located and what they do.

Conclusion

Organization is crucial, especially with larger and more complicated projects. Coding standards can help establish a pattern for software engineers to follow, even if there are many interrelated variables and functions. While coding standards are not required to make working programs, they will likely make code easier to read and understand overall.