51369b610e
When an include is not surrounded by empty lines, its content is inlined on the same line as the adjacent content. That can lead to broken tags and other display issues. This PR fixes all such includes and introduces a validation step that forbids introducing the same problem again.
58 lines
979 B
Plaintext
58 lines
979 B
Plaintext
== Why is this an issue?
|
|
|
|
include::../description.adoc[]
|
|
|
|
=== Noncompliant code example
|
|
|
|
[source,csharp]
|
|
----
|
|
public static void DoSomething()
|
|
{
|
|
for(int i = 0; i < 4; i++) // Noncompliant, 4 is a magic number
|
|
{
|
|
...
|
|
}
|
|
}
|
|
----
|
|
|
|
=== Compliant solution
|
|
|
|
[source,csharp]
|
|
----
|
|
private const int NUMBER_OF_CYCLES = 4;
|
|
|
|
public static void DoSomething()
|
|
{
|
|
for(int i = 0; i < NUMBER_OF_CYCLES ; i++) //Compliant
|
|
{
|
|
...
|
|
}
|
|
}
|
|
----
|
|
|
|
=== 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
|
|
|
|
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[]
|