Code Smell 105 - Comedian Methods
Use professional and meaningful names
TL;DR: Don't be informal or offensive
- Choose good and professional names.
Our profession has a creative side.
Sometimes we get bored and try to be funny.
function erradicateAndMurderAllCustomers(); //unprofessional and offensive
function deleteAllCustomers(); //more declarative and professional
We can have a list of forbidden words.
We can also check them in code reviews.
Names are contextual, so it would be a difficult task for an automatic linter.
Naming conventions should be generic and should not include cultural jargon.
Be professional in the way you name things in your code.
Don't be try to be a comedian by giving a variable a silly name.
You should write production code so future software developers (even you) should easily understand.
This ‘users are idiots, and are confused by functionality’ mentality of Gnome is a disease. If you think your users are idiots, only idiots will use it.
This article is part of the CodeSmell Series.