Skip to content

Latest commit

 

History

History
41 lines (29 loc) · 1.05 KB

MagicNumber.md

File metadata and controls

41 lines (29 loc) · 1.05 KB

Pattern: Use of magic number

Issue: -

Description

Replacing a magic number with a named constant can make code easier to read and understand, and can avoid some subtle bugs. A simple assignment to a val is not considered to be a magic number, for example:

val foo = 4

is not a magic number, but

var foo = 4

is considered to be a magic number.

Parameters

NameDescriptionTypeDefault Value
ignore Ignore string -1,0,1,2

Example configuration

<check enabled="true" class="org.scalastyle.scalariform.MagicNumberChecker" level="warning">
 <parameters>
  <parameter name="ignore">-1,0,1,2,3</parameter>
 </parameters>
</check>