Prefer to use an expression body for functions whose body consists of a single expression

·

[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]Prefer using an expression body for functions with the body consisting of a single expression.[/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 function consisting of a single instruction is using a body implementation (instructions enclosed between accolades).

 

fun foo(): Int {     // +1 VIOLATION
    return 1 
}
 
fun foo() = 1        // +0 good
 
fun foo(): Int {     // +0  because instruction is a "if" statement
   if (toto) {
       return 1
    }
}
 
fun foo(): Int {     // +0  because instruction is a "if" statement
   if (toto) {
       return 1
    }
}
 
// +0 because the instruction is written over at least 5 lines.
public inline fun <T, K> Iterable<T>.groupingBy(crossinline keySelector: (T) -> K): Grouping<T, K> {
    return object : Grouping<T, K> {
        override fun sourceIterator(): Iterator<T> = this@groupingBy.iterator()
        override fun keyOf1(element: T): K = keySelector(element1)
        override fun keyOf2(element: T): K = keySelector(element2)
    }
}

[/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#function-formatting[/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 *