Be Imperative!!
TL;DR: Functions with unclear names hide intent and confuse readers. Use descriptive, action-oriented names.
Functions named with generic terms force readers to dive into the implementation to understand their behavior.
This wastes time and increases the chance of errors.
Naming becomes even more critical when working with standalone functions, where the class name doesn't provide additional context.
This issue directly relates to the Tell, Don’t Ask principle.
Instead of exposing ambiguous behaviors that force the caller to infer functionality, imperative names convey the exact action, guiding the reader without needing to inspect the code.
When you name functions descriptively, you eliminate unnecessary guesswork and align with this principle.
public String dateFormatting(Date date) {
return new SimpleDateFormat("yyyy-MM-dd").format(date);
}
public void load() {
System.out.println("Loading...");
}
public String formatDate(Date date) {
return new SimpleDateFormat("yyyy-MM-dd").format(date);
}
public void loadUserPreferences() {
System.out.println("Loading user preferences...");
}
[X] Manual
You can detect this smell by reviewing function names that use vague terms like do, run, process, load, etc.
Automated linters can flag these patterns or highlight functions with overly generic names.
[X] Beginner
Function names should create a clear one-to-one correspondence between their name and functionality.
Breaking this Bijection forces developers to examine code details for context, slowing down debugging, reviews, and extensions.
AI tools sometimes generate generic function names without understanding your domain.
When using AI, specify that function names must be descriptive and action-oriented.
AI models can help detect ambiguous names by comparing function signatures with predefined naming best practices.
Combining AI with manual code review yields the best results.
Remember: AI Assistants make lots of mistakes
| Without Proper Instructions | With Specific Instructions |
|---|---|
| ChatGPT | ChatGPT |
| Claude | Claude |
| Perplexity | Perplexity |
| Copilot | Copilot |
| Gemini | Gemini |
Function names are not just labels; they are contracts with the reader.
Ambiguous names break this contract and lead to confusion.
Descriptive, action-oriented names simplify communication and make your code easier to maintain and extend.
Code Smells are my opinion.
Photo by britishlibrary on Unsplash
A function name should be a verb or a verb phrase, and it needs to be
meaningful
Robert C. Martin
This article is part of the CodeSmell Series.
The above is the detailed content of Code Smell - Non-Imperative Functions Names. For more information, please follow other related articles on the PHP Chinese website!
![[Web front-end] Node.js quick start](https://img.php.cn/upload/course/000/000/067/662b5d34ba7c0227.png)
