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.
59 lines
1.3 KiB
Plaintext
59 lines
1.3 KiB
Plaintext
== Why is this an issue?
|
|
|
|
include::../description.adoc[]
|
|
|
|
=== Noncompliant code example
|
|
|
|
[source,vbnet]
|
|
----
|
|
Public Class FruitException ' Noncompliant - this has nothing to do with Exception
|
|
Private expected As Fruit
|
|
Private unusualCharacteristics As String
|
|
Private appropriateForCommercialExploitation As Boolean
|
|
' ...
|
|
End Class
|
|
|
|
Public Class CarException ' Noncompliant - does not derive from any Exception-based class
|
|
Public Sub New(message As String, inner As Exception)
|
|
' ...
|
|
End Sub
|
|
End Class
|
|
----
|
|
|
|
=== Compliant solution
|
|
|
|
[source,vbnet]
|
|
----
|
|
Public Class FruitSport ' Compliant - class name does not end with 'Exception'
|
|
Private expected As Fruit
|
|
Private unusualCharacteristics As String
|
|
Private appropriateForCommercialExploitation As Boolean
|
|
' ...
|
|
End Class
|
|
|
|
Public Class CarException Inherits Exception ' Compliant - correctly extends System.Exception
|
|
Public Sub New(message As String, inner As Exception)
|
|
MyBase.New(message, inner)
|
|
' ...
|
|
End Sub
|
|
End Class
|
|
|
|
----
|
|
|
|
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[] |