16f6c0aecf
Inline adoc files when they are included exactly once. Also fix language tags because this inlining gives us better information on what language the code is written in.
63 lines
1.2 KiB
Plaintext
63 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[] |