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.
89 lines
1.3 KiB
Plaintext
89 lines
1.3 KiB
Plaintext
== Why is this an issue?
|
|
|
|
include::../description.adoc[]
|
|
|
|
=== Noncompliant code example
|
|
|
|
[source,vbnet]
|
|
----
|
|
Public Class Fruit
|
|
|
|
Protected PlantingSeason As String
|
|
|
|
' ...
|
|
|
|
End Class
|
|
|
|
Public Class Raspberry
|
|
Inherits Fruit
|
|
|
|
Protected Plantingseason As String ' Noncompliant
|
|
|
|
' ...
|
|
|
|
End Class
|
|
----
|
|
|
|
=== Compliant solution
|
|
|
|
[source,vbnet]
|
|
----
|
|
Public Class Fruit
|
|
|
|
Protected PlantingSeason As String
|
|
|
|
' ...
|
|
|
|
End Class
|
|
|
|
Public Class Raspberry
|
|
Inherits Fruit
|
|
|
|
Protected WhenToPlant As String
|
|
|
|
' ...
|
|
|
|
End Class
|
|
----
|
|
Or
|
|
|
|
[source,vbnet]
|
|
----
|
|
Public Class Fruit
|
|
|
|
Protected PlantingSeason As String
|
|
|
|
' ...
|
|
|
|
End Class
|
|
|
|
Public Class Raspberry
|
|
Inherits Fruit
|
|
|
|
' Field removed, parent field will be used instead
|
|
|
|
End Class
|
|
----
|
|
|
|
=== Exceptions
|
|
|
|
This rule ignores same-name fields that are ``++Shared++`` in both the parent and child classes. It also ignores ``++Private++`` parent class fields and fields explicitly declared as ``++Shadows++``, but in all other such cases, the child class field should be renamed.
|
|
|
|
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[]
|