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);
    }
} Detection [x]Automatic You can add rules to your linter preventing these redundant names. Tags Naming Level [x]Beginner AI Generation AI code generators produce this smell if they try to over-describe property names. They tend to generate overly verbose names to be explicit, which can lead to redundancy. AI Detection AI tools can fix this smell if you instruct them to simplify property names. They can refactor your code to use more concise and clear names. Conclusion Simplifying property names by removing prefixes like "collection" leads to more readable and maintainable code. It would be best to focus on clear, direct names that communicate the purpose without redundancy. Relations Code Smell 38 - Abstract Names Code Smell 171 - Plural Classes Code Smell 113 - Data Naming More Info What exactly is a name - Part II Rehab Disclaimer Code Smells are my opinion. Credits Photo by Karen Vardazaryan on Unsplash Good design adds value faster than it adds cost. Thomas C. Gale Software Engineering Great Quotes This article is part of the CodeSmell Series. How to Find the Stinky Parts of your Code Avoid Using the Prefix "Collection" on Properties Avoid Using the Prefix "Collection" on Properties TL;DR: Drop "collection" prefix for clarity. TL;DR: Drop "collection" prefix for clarity. Problems Redundant Naming Verbose Code Reduced Readability Refactoring Challenges Coupled to implementation 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.' Use Simple Names Remove 'collection' from the name 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);
    }
} 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);
    }
} struct Task {
    subtasks: Vec<Subtask>,
}

impl Task {
    fn add_subtask(&mut self, subtask: Subtask) {
        self.subtasks.push(subtask);
    }
} Detection [x]Automatic [x] Automatic [x] You can add rules to your linter preventing these redundant names. Tags Naming Naming Level [x]Beginner [x] Beginner [x] AI Generation AI code generators produce this smell if they try to over-describe property names. They tend to generate overly verbose names to be explicit, which can lead to redundancy. AI Detection AI tools can fix this smell if you instruct them to simplify property names. They can refactor your code to use more concise and clear names. Conclusion Simplifying property names by removing prefixes like "collection" leads to more readable and maintainable code. It would be best to focus on clear, direct names that communicate the purpose without redundancy. Relations Code Smell 38 - Abstract Names Code Smell 38 - Abstract Names Code Smell 171 - Plural Classes Code Smell 171 - Plural Classes Code Smell 113 - Data Naming Code Smell 113 - Data Naming More Info What exactly is a name - Part II Rehab What exactly is a name - Part II Rehab Disclaimer Code Smells are my opinion . opinion Credits Photo by Karen Vardazaryan on Unsplash Karen Vardazaryan Unsplash Good design adds value faster than it adds cost. Good design adds value faster than it adds cost. Thomas C. Gale Thomas C. Gale Software Engineering Great Quotes Software Engineering Great Quotes This article is part of the CodeSmell Series. How to Find the Stinky Parts of your Code How to Find the Stinky Parts of your Code

Code Smell 258 - The Dangers of Hardcoding Secrets

Refactoring 014 - How to Remove IF

Buy My Book

Code Smell 257 - Simplifying Property Names By Removing Prefixes

About Author

Comments

TOPICS

THIS ARTICLE WAS FEATURED IN

Related Stories

Untitled Story

10 Predictions About the Future of Finance

106 Stories To Learn About Clean Code

100 Pieces of Programming Advice from the Book Clean Code by Robert Martin

110 Stories To Learn About Refactoring

3 Things Coding And Prose Writing Have In Common According To Cory House

10 Predictions About the Future of Finance

106 Stories To Learn About Clean Code

100 Pieces of Programming Advice from the Book Clean Code by Robert Martin

110 Stories To Learn About Refactoring

3 Things Coding And Prose Writing Have In Common According To Cory House

Light-Mode

Classic

Newspaper

Dark-Mode

Neon Noir

Minty

HN StartUps