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.
60 lines
1.3 KiB
Plaintext
60 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[] |