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.
54 lines
1.2 KiB
Plaintext
54 lines
1.2 KiB
Plaintext
== Why is this an issue?
|
|
|
|
include::../description.adoc[]
|
|
|
|
=== Noncompliant code example
|
|
|
|
[source,csharp]
|
|
----
|
|
public class Empty // Noncompliant
|
|
{
|
|
}
|
|
----
|
|
|
|
=== Compliant solution
|
|
|
|
[source,csharp]
|
|
----
|
|
public interface IEmpty
|
|
{
|
|
}
|
|
----
|
|
|
|
=== Exceptions
|
|
|
|
Partial classes are ignored entirely, as they are often used with Source Generators.
|
|
Subclasses of System.Exception are ignored, as even an empty Exception class can provide useful information by its type name alone.
|
|
Subclasses of System.Attribute are ignored, as well as classes which are annotated with attributes.
|
|
Subclasses of generic classes are ignored, as even when empty they can be used for type specialization.
|
|
Subclasses of certain framework types - like the PageModel class used in ASP.NET Core Razor Pages - are also ignored.
|
|
|
|
[source,csharp]
|
|
----
|
|
using Microsoft.AspNetCore.Mvc.RazorPages;
|
|
|
|
public class EmptyPageModel: PageModel // Compliant - an empty PageModel can be fully functional, the C# code can be in the cshtml file
|
|
{
|
|
}
|
|
----
|
|
|
|
ifdef::env-github,rspecator-view[]
|
|
|
|
'''
|
|
== Implementation Specification
|
|
(visible only on this page)
|
|
|
|
include::../message.adoc[]
|
|
|
|
'''
|
|
== Comments And Links
|
|
(visible only on this page)
|
|
|
|
include::../comments-and-links.adoc[]
|
|
|
|
endif::env-github,rspecator-view[] |