131 reads

Code Smell 257 - Simplifying Property Names By Removing Prefixes

by Maximiliano ContieriJuly 9th, 2024

Too Long; Didn't Read

Avoid Using the Prefix "Collection" on Properties. Use Simple Names. Remove 'collection' from the name. Use plural names without the word 'collection.' When you prefix properties with terms like "collection," you introduce redundancy and verbosity into your code. This makes your code harder to read and maintain. Good design adds value faster than it adds cost.

featured image - Code Smell 257 - Simplifying Property Names By Removing Prefixes

Avoid Using the Prefix "Collection" on Properties

TL;DR: Drop "collection" prefix for clarity.

Problems

Redundant Naming
Verbose Code
Reduced Readability
Refactoring Challenges
Coupled to implementation

Solutions

Use Simple Names
Remove 'collection' from the name
Use plural names without the word 'collection.'

Context

When you prefix properties with terms like "collection," you introduce redundancy and verbosity into your code.

This makes your code harder to read and maintain and adds unnecessary complexity.

Coupling the name to a collection implementation prevents you from introducing a proxy or middle object to manage the relation.

Sample Code

Wrong

struct Task {
    collection_of_subtasks: Vec<Subtask>,
    subtasks_collection: Vec<Subtask>,
}

impl Task {
    fn add_subtask(&mut self, subtask: Subtask) {
        self.collection_of_subtasks.push(subtask);
        self.subtasks_collection.push(subtask);
    }
}

Right

struct Task {
    subtasks: Vec<Subtask>,
}

impl Task {
    fn add_subtask(&mut self, subtask: Subtask) {
        self.subtasks.push(subtask);
    }
}