Uploaded image for project: 'Rules Repository'
  1. Rules Repository
  2. RSPEC-109

Magic numbers should not be used

    XMLWordPrintable

    Details

    • Type: Code Smell Detection
    • Status: Active
    • Resolution: Unresolved
    • Labels:
    • Message:
      Assign this magic number X to a well-named (variable|constant), and use the (variable|constant) instead.
    • Default Severity:
      Major
    • Impact:
      Low
    • Likelihood:
      High
    • Legacy Key:
      MagicNumber, COBOL.MagicNumberCheck
    • Targeted languages:
      Flex, PHP, Python, RPG, Swift, VB.Net
    • Covered Languages:
      ABAP, C#, C, C++, Cobol, Java, JavaScript, Objective-C, PL/SQL, TypeScript, VB6
    • Remediation Function:
      Constant/Issue
    • Constant Cost:
      5min
    • Analysis Scope:
      Main Sources
    • Checkstyle:
      MagicNumber
    • ESLint:
      no-magic-numbers
    • PMD:
      AvoidLiteralsInIfCondition

      Description

      A magic number is a number that comes out of nowhere, and is directly used in a statement. Magic numbers are often used, for instance to limit the number of iterations of a loop, to test the value of a property, etc.

      Using magic numbers may seem obvious and straightforward when you're writing a piece of code, but they are much less obvious and straightforward at debugging time.

      That is why magic numbers must be demystified by first being assigned to clearly named variables before being used.

      -1, 0 and 1 are not considered magic numbers.

        Attachments

          Issue Links

          is duplicated by

          Finding Detection - RSPEC-1977 Named constants should be used for indicators

          • Closed
          is implemented by

          Bug - A problem which impairs or prevents the functions of the product. SONARJAVA-1388 Rule S109 (MagicNumber): Rule should not raise issue with fields from interfaces

          • Major - Major loss of function.
          • Closed

          New Feature - A new feature of the product, which has yet to be developed. SONARSWIFT-343 Rule: Magic numbers should not be used

          • Major - Major loss of function.
          • Open

          New Feature - A new feature of the product, which has yet to be developed. CPP-299 Rule: Magic number should not be spreaded everywhere in the source code

          • Major - Major loss of function.
          • Closed

          New Feature - A new feature of the product, which has yet to be developed. SONARABAP-63 Rule : Magic numbers should not be used

          • Major - Major loss of function.
          • Closed

          New Feature - A new feature of the product, which has yet to be developed. SONARVBSIX-163 Rule: Magic numbers should not be used

          • Minor - Minor loss of function, or other problem where easy workaround is present.
          • Closed

          Task - A task that needs to be done. CPP-707 Create Objective-C rules repository containing targeted rules

          • Major - Major loss of function.
          • Closed

          Improvement - An improvement or enhancement to an existing feature or task. SONARABAP-252 Magic Number rule should work on chained statements.

          • Major - Major loss of function.
          • Open

          Improvement - An improvement or enhancement to an existing feature or task. SONARJAVA-1079 S109 - Magic Numbers: add an "authorized numbers" parameter

          • Major - Major loss of function.
          • Closed

          Improvement - An improvement or enhancement to an existing feature or task. SONARJAVA-1235 S109 should not consider as magic number final (but not static) fields with initialization

          • Major - Major loss of function.
          • Closed
          is related to

          New Feature - A new feature of the product, which has yet to be developed. CPP-2748 Rule S6164: Mathematical constants should not be hardcoded

          • Major - Major loss of function.
          • Closed

          Code Smell Detection - RSPEC-2480 "FOR" loop end conditions should not be hard-coded

          • Active

          Code Smell Detection - RSPEC-1583 Magic literals should not be used

          • Active
          relates to

          Code Smell Detection - RSPEC-6164 Mathematical constants should not be hardcoded

          • Active

          Improvement - An improvement or enhancement to an existing feature or task. SONARCOBOL-997 Remove useless rule "Magic Literal"

          • Major - Major loss of function.
          • Closed
          1.
          		 RPG - Named constants should be used for indicators RSPEC-2049 Language-Specification Active Unassigned
          2.
          		 C-Family RSPEC-2904 Language-Specification Active Unassigned
          3.
          		 VB.NET RSPEC-3103 Language-Specification Active Unassigned
          4.
          		 Java RSPEC-3161 Language-Specification Active Unassigned
          5.
          		 JavaScript RSPEC-3162 Language-Specification Active Unassigned
          6.
          		 VB6 RSPEC-3163 Language-Specification Active Unassigned
          7.
          		 ABAP RSPEC-3164 Language-Specification Active Unassigned
          8.
          		 Cobol RSPEC-3569 Language-Specification Active Unassigned
          9.
          		 PL/SQL RSPEC-3570 Language-Specification Active Unassigned
          10.
          		 C# RSPEC-3572 Language-Specification Active Unassigned

            Activity

              People

              Assignee:
              Unassigned Unassigned
              Reporter:
              freddy.mallet Freddy Mallet (Inactive)
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

                Dates

                Created:
                Updated: