A typical code smell known as unused function parameters refers to parameters declared in a function but not used anywhere within the function’s body. While this might seem harmless at first glance, it can lead to confusion and potential errors in your code. Disregarding the values passed to such parameters, the function’s behavior will be the same, but the programmer’s intention won’t be clearly expressed anymore. Therefore, removing function parameters that are not being utilized is considered best practice.
When arguments is used in the function body, no parameter is reported as unused.
function doSomething(a, b, c) {
compute(arguments);
}
The rule also ignores all parameters with names starting with an underscore (_). This practice is often used to indicate that some
parameter is intentionally unused. This practice is frequently seen in the TypeScript compiler, for example.
function doSomething(_a, b) {
return compute(b);
}
Having unused function parameters in your code can lead to confusion and misunderstanding of a developer’s intention. They reduce code readability and introduce the potential for errors. To avoid these problems, developers should remove unused parameters from function declarations.
function doSomething(a, b) { // "a" is unused
return compute(b);
}
function doSomething(b) {
return compute(b);
}
or
function doSomething(_a, b) {
return compute(b);
}