Avoid too abstract names. Names should have real world meaning
Problems
Solutions
Choose meaningful names.
Find metaphors.
Avoid words like abstract, base, generic, helper etc.
Use rules for naming.
Sample Code
Wrong
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| <? | |
| final class MeetingsCollection {} | |
| final class AccountsComposite {} | |
| final class NotesArray {} | |
| final class LogCollector {} | |
| abstract class AbstractTransportation {} |
Right
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| <? | |
| final class Schedule {} | |
| final class Portfolio {} | |
| final class NoteBook {} | |
| final class Journal {} | |
| final class Vehicle {} |
Detection
We can set up policies and rules warning for certain words like base, abstract, helper, manager, object etc.
Tags
- Naming
Conclusion
Finding names is the last thing we should do on our designs. Unless we have a clear business understanding, good names emerge at the end after defined behavior and protocol boundaries.
Relations
More info
Credits
Photo by Rodion Kutsaev on Unsplash
There are only two hard things in Computer Science: cache invalidation and naming things.
Phil Karlton
Top comments (0)