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.
47 lines
795 B
Plaintext
47 lines
795 B
Plaintext
== Why is this an issue?
|
|
|
|
include::../description.adoc[]
|
|
|
|
=== Noncompliant code example
|
|
|
|
[source,csharp]
|
|
----
|
|
public void Foo()
|
|
{
|
|
var g1 = new Guid(); // Noncompliant - what's the intent?
|
|
Guid g2 = new(); // Noncompliant
|
|
var g3 = default(Guid); // Noncompliant
|
|
Guid g4 = default; // Noncompliant
|
|
}
|
|
----
|
|
|
|
=== Compliant solution
|
|
|
|
[source,csharp]
|
|
----
|
|
public void Foo(byte[] bytes)
|
|
{
|
|
var g1 = Guid.Empty;
|
|
var g2 = Guid.NewGuid();
|
|
var g3 = new Guid(bytes);
|
|
}
|
|
----
|
|
|
|
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[]
|