Do you follow coding standards and conventions?

It's important to note that, not all, but much of what coding standards prescribe depends on the programming language being used. So it's important to remember that these are guidelines, not definitive truths about the way developers should work. For example, one of the aspects that coding standards generally address is the rules for indenting code. Now, this is a very different issue for those coding in Python (where indentation is part of the language) than it is for those coding in C-based languages. My main point is that coding standards are important and should be considered, but at the same time they should not take be taken as absolute and definitive, especially when they conflict with creativity, which can sometimes be a key factor.

Coding standards and conventions guide developers toward best practices, ensuring code is consistent, readable, and maintainable. In the absence of coding standards, codebases can turn chaotic, making it difficult for teams to understand and collaborate on projects. Regardless of who's writing or reading the code, there should be a shared understanding of its structure and intent.

In addition to the above, adhering to a set of coding standards is a way for programmers to be disciplined, to follow sound practices that have been well tested by others, without having to reinvent the wheel or making mistakes that could be avoided.

Remember that code is typically read more times than it is written. Also, code that is easy to read is also easy to review, which raises the quality in the end. Having the same way of expressing the same thing ensures that a reviewer doesn't misread the code. Some of the conventions also include best practices when it comes to code design. These are typically built on years of experience on what works best. You should normally follow these best practices, but sometimes you need to deviate from them. When doing so, it is important to properly document why using comments.

Linting is like having a robot buddy that looks at your code and points out mistakes and style problems. It makes your code follow the rules. Linters, like ESLint for JavaScript or PyLint for Python, are tools that do this. They help keep your code neat and readable. By using them, your code is less likely to have errors.

While using comments in your code, keep in mind that their job is not restating the obvious. Code is ideally self-explanatory. Instead, it's suggested to clarify the "why" behind your code. Share insights, reasoning, and potential challenges, making your comments a valuable resource for understanding the thought process. In summary, comment for the "why," not just the "what."

The conventions used for naming variables, constants, functions or classes are a fundamental aspect of coding standards, including criteria for terms, words and their combinations (verbs, nouns, singular, plural, gender, ...). If each programmer chooses names according to his preferences or momentary impulses, this will be a subjective factor in the interpretation of the code by others and in its long-term maintenance.

If you feel you need a comment (or a colleague feel you need it), then ask yourself why. Was the naming misleading? Or the design? Usually you can remove comments by having better names and design, but in case this cannot be done, then yes, add a comment. If you think in this way, then comments will be rare, and suddenly people will start to read them since they stick out. This is a good thing, since they will now suddenly indicate that something isn't what you might think.

One common challenge is the existence of multiple standards, which can vary by organization, language, or even project. Many differing guidelines can lead to confusion, especially for developers transitioning between projects or teams. Some tips for following coding standards and conventions are clear documentation, automation where possible, regular code reviews, staying up to date, and prioritizing clarity over rigidity.