Code Smell 128 - Non English Coding

Photo by Anna Vander Stel on Unsplash

Code Smell 128 - Non English Coding

Using your local language is a great idea because domain naming is easier. Not

Maxi Contieri
·Apr 9, 2022·

2 min read

Subscribe to my newsletter and never miss my upcoming articles

Listen to this article

Table of contents

  • Problems
  • Solutions
  • Context
  • Sample Code
  • Detection
  • Tags
  • Conclusion
  • More Info
  • Credits

TL;DR: Stick to English. Always.

Problems

  • Polymorphism

  • Cultural gaps

  • Mixed Code

  • Syntactic Errors

Solutions

  1. Write in English

  2. Rename Domain Concepts to English

Context

All programming languages are written in English.

Unless for a few failed experiments during the 90's all modern languages use English for their primitives and their frameworks.

if you wanted to read or write in medieval Europe, you had to acquire a new language at the same time. Writing meant Latin.

This is true for programming languages nowadays.

I am not a Native English speaker.

My code (tries to be) in English.

Sample Code

Wrong

const elements = new Set();

elements.add(1);
elements.add(1);

elements.size() = 1 
//This is the standard set

var moreElements = new MultiConjunto();
//We defined a multiset in Spanish
//because we are extending the domain

moreElements.agregar('hello');
moreElements.agregar('hello');
//'agregar' is the Spanish word for 'add'

moreElements.size() = 2 //Since it is a multiset

//elements and moreElements are NOT polymorphic
//I cannot exchange their implementation

Right

const elements = new Set();

elements.add(1);
elements.add(1);

elements.size() = 1 
//This is the standard set

var moreElements = new MultiSet();
//We defined a multiset in English

moreElements.add('hello');
moreElements.add('hello');

moreElements.size() = 2 //Since it is a multiset

//elements and moreElements are polymorphic
//I can exchange their implementation anytime

Detection

[X] Automatic

Most IDEs and linters have a thesaurus.

We can search for foreign words.

Tags

  • Readability

Conclusion

Don't mix Non-English domain words with English primitives.

Even when Mapping your real-world entities, use plain English.

More Info

Credits

Photo by Anna Vander Stel on Unsplash


A programming language is a tool that has a profound influence on our thinking habits.

Edsger Dijkstra


This article is part of the CodeSmell Series.

 
Share this

Impressum

Technical Opinions are my own. I don't have the revealed truth.

Software Design is a creative activity. These are hints and not rigid rules.

I write on BackEnd Business Systems and OOP Design. My advice/experience might not suit other systems.