
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.
44 lines
767 B
Plaintext
44 lines
767 B
Plaintext
== Why is this an issue?
|
|
|
|
include::../description.adoc[]
|
|
|
|
=== Noncompliant code example
|
|
|
|
[source,vbnet]
|
|
----
|
|
Public Sub Foo()
|
|
Dim G1 As New Guid ' Noncompliant - what's the intent?
|
|
Dim G2 As Guid = Nothing ' Noncompliant
|
|
End Sub
|
|
----
|
|
|
|
=== Compliant solution
|
|
|
|
[source,vbnet]
|
|
----
|
|
public void Foo(byte[] bytes)
|
|
Public Sub Foo(Bytes As Byte())
|
|
Dim G1 As Guid = Guid.Empty
|
|
Dim G2 As Guid = Guid.NewGuid()
|
|
Dim G3 As Guid = New Guid(Bytes)
|
|
End Sub
|
|
----
|
|
|
|
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[]
|