DEV Community πŸ‘©β€πŸ’»πŸ‘¨β€πŸ’»

DEV Community πŸ‘©β€πŸ’»πŸ‘¨β€πŸ’» is a community of 968,547 amazing developers

We're a place where coders share, stay up-to-date and grow their careers.

Create account Log in
Cover image for Code Smell 98 - Speling Mistakes
Maxi Contieri
Maxi Contieri

Posted on • Originally published at maximilianocontieri.com

Code Smell 98 - Speling Mistakes

Spelling and readability are very important for humans and not important for machines.

TL;DR: Take care of your names.

Problems

  • Readability

Solutions

  1. Spellcheck your code.

  2. Use an IDE with spellchecking

Context

Many of us don't speak English as our first language.

We need to have extra care for our texts and names.

This article has a typo in its title as proof of context and also a clickbaitπŸ˜€

Sample Code

Wrong

comboFeededBySupplyer = supplyer.providers();
Enter fullscreen mode Exit fullscreen mode

Right

comboFedBySupplier = supplier.providers();
Enter fullscreen mode Exit fullscreen mode

Detection

[X] Manual

  • We need to read the code in a peer review.

[X] Automatic

  • Some IDEs have warnings on the typos.

Tags

  • Readability

  • Naming

Conclusion

Pay close attention to your names.

You will probably be the person reading the code in a few months.

More Info

Credits

Photo by Brett Jordan on Unsplash

Inside every well-written large program is a well-written small program.

C.A.R. Hoare


This article is part of the CodeSmell Series.

Top comments (0)

πŸ—£ Want to join the conversation?

It's easy! Become a DEV member to follow this post, comment, and more.