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.
65 lines
1.0 KiB
Plaintext
65 lines
1.0 KiB
Plaintext
== Why is this an issue?
|
|
|
|
:func_name: method
|
|
|
|
include::../description.adoc[]
|
|
|
|
[source,csharp,diff-id=1,diff-type=noncompliant]
|
|
----
|
|
private const string CODE = "secret";
|
|
private int callCount = 0;
|
|
|
|
public string GetCode()
|
|
{
|
|
callCount++;
|
|
return CODE;
|
|
}
|
|
|
|
public string GetName() // Noncompliant: duplicates GetCode
|
|
{
|
|
callCount++;
|
|
return CODE;
|
|
}
|
|
----
|
|
|
|
include::../inter.adoc[]
|
|
|
|
[source,csharp,diff-id=1,diff-type=compliant]
|
|
----
|
|
private const string CODE = "secret";
|
|
private int callCount = 0;
|
|
|
|
public string GetCode()
|
|
{
|
|
callCount++;
|
|
return CODE;
|
|
}
|
|
|
|
public string GetName() // Intent is clear
|
|
{
|
|
return GetCode();
|
|
}
|
|
----
|
|
|
|
=== Exceptions
|
|
|
|
Empty methods, methods with only one line of code and methods with the same name (overload) are ignored.
|
|
|
|
ifdef::env-github,rspecator-view[]
|
|
|
|
'''
|
|
== Implementation Specification
|
|
(visible only on this page)
|
|
|
|
include::../message.adoc[]
|
|
|
|
include::../highlighting.adoc[]
|
|
|
|
'''
|
|
== Comments And Links
|
|
(visible only on this page)
|
|
|
|
include::../comments-and-links.adoc[]
|
|
|
|
endif::env-github,rspecator-view[]
|