Your Web News in One Place

Help Webnuz

Referal links:

Sign up for GreenGeeks web hosting
October 29, 2022 04:27 pm GMT

Code Smell 174 - Class Name in Attributes

Redundancy in names is a bad smell. Names should be contextual

TL;DR: Don't prefix your attributes with your class name

Problems

  • Not Contextual Names

Solutions

  1. Remove the class prefix from the attribute

Context

This is a naming smell, we should not read attributes in isolation and names are contextual.

Sample Code

Wrong

public class Employee {   String empName = "John";   int empId = 5;   int empAge = 32;}

Right

public class Employee {   String name;   int id; // Ids are another smell   int age; // Storing the age is yet another smell}

Detection

[X] Semi-Automatic

When the full name is included in the prefix, our linters can warn us.

Tags

  • Naming

Conclusion

Careful naming is a very important task.

We need to name after the behavior, not type or data

Relations

More Info

Disclaimer

Code Smells are just my opinion.

Credits

Photo by Phoenix Han on Unsplash

Copying skips understanding. Understanding is how you grow. You have to understand why something works or why something is how it is. When you copy it, you miss that. You just repurpose the last layer instead of understanding all the layers underneath.

Jason Fried

This article is part of the CodeSmell Series.


Original Link: https://dev.to/mcsee/code-smell-174-class-name-in-attributes-55c

Share this article:    Share on Facebook
View Full Article

Dev To

An online community for sharing and discovering great ideas, having debates, and making friends

More About this Source Visit Dev To