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.
64 lines
1.2 KiB
Plaintext
64 lines
1.2 KiB
Plaintext
== Why is this an issue?
|
|
|
|
include::../description.adoc[]
|
|
|
|
=== Noncompliant code example
|
|
|
|
[source,csharp]
|
|
----
|
|
public class FruitException // Noncompliant - this has nothing to do with Exception
|
|
{
|
|
private Fruit expected;
|
|
private string unusualCharacteristics;
|
|
private bool appropriateForCommercialExploitation;
|
|
// ...
|
|
}
|
|
|
|
public class CarException // Noncompliant - does not derive from any Exception-based class
|
|
{
|
|
public CarException(string message, Exception inner)
|
|
{
|
|
// ...
|
|
}
|
|
}
|
|
----
|
|
|
|
=== Compliant solution
|
|
|
|
[source,csharp]
|
|
----
|
|
public class FruitSport // Compliant - class name does not end with 'Exception'
|
|
{
|
|
private Fruit expected;
|
|
private string unusualCharacteristics;
|
|
private bool appropriateForCommercialExploitation;
|
|
// ...
|
|
}
|
|
|
|
public class CarException: Exception // Compliant - correctly extends System.Exception
|
|
{
|
|
public CarException(string message, Exception inner): base(message, inner)
|
|
{
|
|
// ...
|
|
}
|
|
}
|
|
----
|
|
|
|
ifdef::env-github,rspecator-view[]
|
|
|
|
'''
|
|
== Implementation Specification
|
|
(visible only on this page)
|
|
|
|
=== Message
|
|
|
|
Rename this class to remove "Exception" or correct its inheritance.
|
|
|
|
|
|
'''
|
|
== Comments And Links
|
|
(visible only on this page)
|
|
|
|
include::../comments-and-links.adoc[]
|
|
|
|
endif::env-github,rspecator-view[] |