rspec/rules/S109/csharp/rule.adoc

61 lines
1.1 KiB
Plaintext
Raw Normal View History

2020-06-30 10:16:44 +02:00
include::../description.adoc[]
=== Exceptions
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
- a default value for a method argument
include::../how-to-fix-it.adoc[]
=== Code examples
2020-06-30 10:16:44 +02:00
==== Noncompliant code example
[source,csharp,diff-id=1,diff-type=noncompliant]
2020-06-30 10:16:44 +02:00
----
public void DoSomething()
2020-06-30 10:16:44 +02:00
{
for (int i = 0; i < 4; i++) // Noncompliant, 4 is a magic number
2020-06-30 10:16:44 +02:00
{
...
}
}
----
==== Compliant solution
2020-06-30 10:16:44 +02:00
[source,csharp,diff-id=1,diff-type=compliant]
2020-06-30 10:16:44 +02:00
----
private const int NUMBER_OF_CYCLES = 4;
public void DoSomething()
2020-06-30 10:16:44 +02:00
{
for (int i = 0; i < NUMBER_OF_CYCLES; i++) // Compliant
2020-06-30 10:16:44 +02:00
{
...
}
}
----
ifdef::env-github,rspecator-view[]
'''
== Implementation Specification
(visible only on this page)
include::../message.adoc[]
'''
== Comments And Links
(visible only on this page)
include::../comments-and-links.adoc[]
endif::env-github,rspecator-view[]