[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]Overriding a variable declared in an outer scope can strongly impact the readability, and therefore the maintainability, of a piece of code. Further, it could lead maintainers to introduce bugs because they think they’re using one variable but are really using another.[/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 variable declaration (with var, let or const) is hidding another upper level declaration (variable or parameter).
function foo() {
if (x > 0) {
let y = bar(2); // no shadowing
} else {
let y = bar(3); // no shadowing
}
}
function foo() {
if (x > 0) {
let y = bar(2); // the let declaration is shadowing the var declaration.
} else {
var y = bar(3);
}
}
function foo() {
let y = bar(2); // do not compile because "let y" and "var y" are both in the full function scope.
if (x > 0) {
var y = bar(3);
}
}
function foo() {
if (x > 0) {
let y = 0; // y is not conflicting with "var y" because "var y" is in the full scope of the function, while "let y" is in the scope of the "if" statement". So "let y" is shadowing "var y".
while (more) {
var y = bar(3);
}
}
}
[/vc_column_text][vc_empty_space][vc_separator][vc_column_text]
References
[/vc_column_text][vc_column_text]https://www.appmarq.com/public/security,1021072,Avoid-shadowing-class-variables
https://javascript.plainenglish.io/javascript-best-practices-shadowing-variables-and-spacing-950c0ee2259f[/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