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.
76 lines
1.2 KiB
Plaintext
76 lines
1.2 KiB
Plaintext
== Why is this an issue?
|
|
|
|
include::../description.adoc[]
|
|
|
|
=== Noncompliant code example
|
|
|
|
[source,csharp]
|
|
----
|
|
public class Fruit
|
|
{
|
|
protected string plantingSeason;
|
|
//...
|
|
}
|
|
|
|
public class Raspberry : Fruit
|
|
{
|
|
protected string plantingseason; // Noncompliant
|
|
// ...
|
|
}
|
|
----
|
|
|
|
=== Compliant solution
|
|
|
|
[source,csharp]
|
|
----
|
|
public class Fruit
|
|
{
|
|
protected string plantingSeason;
|
|
//...
|
|
}
|
|
|
|
public class Raspberry : Fruit
|
|
{
|
|
protected string whenToPlant;
|
|
// ...
|
|
}
|
|
----
|
|
Or
|
|
|
|
[source,csharp]
|
|
----
|
|
public class Fruit
|
|
{
|
|
protected string plantingSeason;
|
|
//...
|
|
}
|
|
|
|
public class Raspberry : Fruit
|
|
{
|
|
// field removed; parent field will be used instead
|
|
// ...
|
|
}
|
|
----
|
|
|
|
=== Exceptions
|
|
|
|
This rule ignores same-name fields that are ``++static++`` in both the parent and child classes. It also ignores ``++private++`` parent class fields, 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[]
|