2023-05-03 11:06:20 +02:00
|
|
|
== Why is this an issue?
|
|
|
|
|
2020-06-30 10:16:44 +02:00
|
|
|
include::../description.adoc[]
|
|
|
|
|
2023-05-03 11:06:20 +02:00
|
|
|
=== Noncompliant code example
|
2020-06-30 10:16:44 +02:00
|
|
|
|
2022-02-04 17:28:24 +01:00
|
|
|
[source,csharp]
|
2020-06-30 10:16:44 +02:00
|
|
|
----
|
|
|
|
public static void DoSomething()
|
|
|
|
{
|
|
|
|
for(int i = 0; i < 4; i++) // Noncompliant, 4 is a magic number
|
|
|
|
{
|
|
|
|
...
|
|
|
|
}
|
|
|
|
}
|
|
|
|
----
|
|
|
|
|
2023-05-03 11:06:20 +02:00
|
|
|
=== Compliant solution
|
2020-06-30 10:16:44 +02:00
|
|
|
|
2022-02-04 17:28:24 +01:00
|
|
|
[source,csharp]
|
2020-06-30 10:16:44 +02:00
|
|
|
----
|
|
|
|
private const int NUMBER_OF_CYCLES = 4;
|
|
|
|
|
|
|
|
public static void DoSomething()
|
|
|
|
{
|
|
|
|
for(int i = 0; i < NUMBER_OF_CYCLES ; i++) //Compliant
|
|
|
|
{
|
|
|
|
...
|
|
|
|
}
|
|
|
|
}
|
|
|
|
----
|
|
|
|
|
2023-05-03 11:06:20 +02:00
|
|
|
=== Exceptions
|
2020-06-30 10:16:44 +02:00
|
|
|
|
2022-01-17 10:54:18 +01:00
|
|
|
This rule doesn't raise an issue when the magic number is used as part of:
|
|
|
|
|
|
|
|
- the ``++GetHashCode++`` method
|
|
|
|
- a variable/field declaration
|
|
|
|
- the single argument of an attribute
|
|
|
|
- a named argument for a method or attribute
|
|
|
|
- a constructor call
|
2021-06-02 20:44:38 +02:00
|
|
|
|
2021-06-03 09:05:38 +02:00
|
|
|
ifdef::env-github,rspecator-view[]
|
2021-09-20 15:38:42 +02:00
|
|
|
|
|
|
|
'''
|
|
|
|
== Implementation Specification
|
|
|
|
(visible only on this page)
|
|
|
|
|
|
|
|
include::../message.adoc[]
|
|
|
|
|
2021-06-08 15:52:13 +02:00
|
|
|
'''
|
2021-06-02 20:44:38 +02:00
|
|
|
== Comments And Links
|
|
|
|
(visible only on this page)
|
|
|
|
|
|
|
|
include::../comments-and-links.adoc[]
|
2021-06-03 09:05:38 +02:00
|
|
|
endif::env-github,rspecator-view[]
|