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.
66 lines
1.3 KiB
Plaintext
66 lines
1.3 KiB
Plaintext
== Why is this an issue?
|
|
|
|
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 loops, 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 constants before being used.
|
|
|
|
=== Noncompliant code example
|
|
|
|
[source,vbnet]
|
|
----
|
|
Class Foo
|
|
Sub DoSomething(Param As Integer)
|
|
If Param > 100 Then ' Magic Number
|
|
' Do something
|
|
End If
|
|
End Sub
|
|
End Class
|
|
----
|
|
|
|
=== Compliant solution
|
|
|
|
[source,vbnet]
|
|
----
|
|
Class Foo
|
|
Private Const MaxOfSomething As Integer = 100
|
|
|
|
Sub DoSomething(Param As Integer)
|
|
If Param > MaxOfSomething Then
|
|
' Do something
|
|
End If
|
|
End Sub
|
|
End Class
|
|
----
|
|
|
|
ifdef::env-github,rspecator-view[]
|
|
|
|
'''
|
|
== Implementation Specification
|
|
(visible only on this page)
|
|
|
|
include::../message.adoc[]
|
|
|
|
=== Parameters
|
|
|
|
.exceptions
|
|
****
|
|
_STRING_
|
|
|
|
----
|
|
-1,0,1,2
|
|
----
|
|
****
|
|
|
|
|
|
'''
|
|
== Comments And Links
|
|
(visible only on this page)
|
|
|
|
include::../comments-and-links.adoc[]
|
|
|
|
endif::env-github,rspecator-view[]
|