A field should not duplicate the name of its containing class

·

[vc_row][vc_column][vc_btn title=”SOFTWARE AGILITY” style=”flat” color=”black” i_icon_fontawesome=”fa fa-shield” add_icon=”true” link=”url:http%3A%2F%2Fdoc.casthighlight.com%2Fsoftware-agility%2F|||”][vc_btn title=”CODE READABILITY” style=”outline” color=”black” i_icon_fontawesome=”fa fa-code” add_icon=”true” link=”url:http%3A%2F%2Fdoc.casthighlight.com%2Fcategory%2Fproduct%2Findicators-methodology%2Fcode-insights%2Fsoftware-agility%2Fcode-readability%2F|||”][vc_empty_space height=”12px”][vc_row_inner][vc_column_inner][vc_column_text]

Why you should care

[/vc_column_text][vc_column_text]It can be confusing to have a class member with the same name (case differences aside) as its enclosing class, especialy when considering the common practice of naming a class instance for the class itself.

Best practice dictates that any field or member with the same name as the enclosing class be renamed to be more descriptive of the particular aspect of the class it represents or holds.[/vc_column_text][vc_empty_space][/vc_column_inner][/vc_row_inner][vc_empty_space height=”12px”][vc_empty_space][vc_separator][vc_column_text]

How we detect

[/vc_column_text][vc_column_text]CAST Highlight counts one occurrence each time a field has the same name than its class or struct.

Bad Code 

public class Foo {
  private var foo : String // NonCompliant
 
  public func getFoo() -> String {
     return foo
  }
}
struct SuperHero {
    var superhero : String  // NonCompliant
    var power: String
    
    func whoIsIt() {
        print("Name: " + self.nom + ", Power: " + self.power)
    }
}
var foo = Foo()
foo.getFoo() // what does this return?

Good Code 

public class Foo {
  private var name : String
  public func getName() -> String {
      return name
  }
}
 
var foo = Foo();
foo.getName()

[/vc_column_text][vc_empty_space][vc_separator][vc_column_text]

References

[/vc_column_text][vc_column_text]https://kotlinlang.org/docs/coding-conventions.html
https://riptutorial.com/kotlin/example/30735/elvis-operator—–
https://github.com/Kotlin/kotlin-style-guide/issues/18[/vc_column_text][vc_empty_space][vc_row_inner][vc_column_inner][vc_single_image image=”5362″ img_size=”full”][vc_column_text]

About CAST and Highlight’s Code Insights

Over the last 25 years, CAST has leveraged unique knowledge on software quality measurement by analyzing thousands of applications and billions of lines of code. Based on this experience and community standards on programming best practices, Highlight implements hundreds of code insights across 15+ technologies to calculate health factors of a software.

[/vc_column_text][vc_empty_space height=”16px”][vc_btn title=”SEE FEATURES” style=”flat” color=”black” i_icon_fontawesome=”fa fa-desktop” add_icon=”true” link=”url:https%3A%2F%2Fwww.castsoftware.com%2Fproducts%2Fhighlight%2Foutputs-analytics||target:%20_blank|”][vc_btn title=”HOW IT WORKS” style=”outline” color=”black” i_icon_fontawesome=”fa fa-cog” add_icon=”true” link=”url:https%3A%2F%2Fwww.castsoftware.com%2Fproducts%2Fhighlight%2Fhow-it-works||target:%20_blank|”][/vc_column_inner][/vc_row_inner][/vc_column][/vc_row]


Leave a Reply

Your email address will not be published. Required fields are marked *