GeezerVison is showing github.com — codeql/java/ql/src/DeadCode/UselessParameter.qhelp at main · github/codeql

Expand file tree

UselessParameter.qhelp

Copy path

More file actions

39 lines (39 loc) · 1.54 KB

Copy path

39 lines (39 loc) · 1.54 KB

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

<!DOCTYPE qhelp PUBLIC

"-//Semmle//qhelp//EN"

"qhelp.dtd">

<qhelp>

Parameters that are never read in the body of the method, and are not required due to overriding,

are useless and can be removed. Useless parameters unnecessarily complicate the interface for that

method, and cause a maintenance and development burden.

Methods with useless parameters indicate that either the method can be simplified by removing the

parameter, or that the method is not using a value it should be using. Parameters of methods that

override other methods will not be marked as useless, because they are required. Similarly,

parameters of methods that are overridden by other methods are not marked as useless if they are

used by one of the overriding methods.

</overview>

The method should be inspected to determine whether the parameter should be used within the body.

If the method is overridden, also consider whether any override methods should be using the

parameter. If the parameter is not required, it should be removed.

</recommendation>

In the following example, we have a method for determining whether a <code>String</code> path

is an absolute path:

The method uses the parameter <code>path</code> to determine the return value. However, the

parameter <code>name</code> is not used within the body of the method. The parameter will be marked

as useless, and can be removed from the program.

</example>

</qhelp>