2023-05-03 11:06:20 +02:00
|
|
|
== Why is this an issue?
|
|
|
|
|
2023-06-09 14:51:36 +02:00
|
|
|
:operationName: method
|
2020-06-30 12:47:33 +02:00
|
|
|
|
2023-10-18 18:21:32 +02:00
|
|
|
include::../description.adoc[]
|
2020-06-30 12:47:33 +02:00
|
|
|
|
2023-05-03 11:06:20 +02:00
|
|
|
=== Exceptions
|
2020-06-30 12:47:33 +02:00
|
|
|
|
2023-06-09 14:51:36 +02:00
|
|
|
The following empty methods are considered compliant:
|
2020-06-30 14:49:38 +02:00
|
|
|
|
2023-06-09 14:51:36 +02:00
|
|
|
* empty `Overridable` methods, as the implementation might not be required in the base class
|
|
|
|
* empty methods that override a `MustOverride` method as the implementation is mandatory for child class
|
|
|
|
* empty overrides in test assemblies for mocking purposes
|
2021-06-02 20:44:38 +02:00
|
|
|
|
2023-10-18 18:21:32 +02:00
|
|
|
== How to fix it
|
|
|
|
|
|
|
|
=== Code examples
|
|
|
|
|
|
|
|
==== Noncompliant code example
|
|
|
|
|
|
|
|
[source,vbnet,diff-id=1,diff-type=noncompliant]
|
|
|
|
----
|
|
|
|
Sub ShouldNotBeEmpty() ' Noncompliant - method is empty
|
|
|
|
End Sub
|
|
|
|
|
|
|
|
Sub NotImplementedYet() ' Noncompliant - method is empty
|
|
|
|
End Sub
|
|
|
|
|
|
|
|
Sub WillNeverBeImplemented() ' Noncompliant - method is empty
|
|
|
|
End Sub
|
|
|
|
|
|
|
|
Sub EmptyOnPurpose() ' Noncompliant - method is empty
|
|
|
|
End Sub
|
|
|
|
----
|
|
|
|
|
|
|
|
==== Compliant solution
|
|
|
|
|
|
|
|
[source,vbnet,diff-id=1,diff-type=compliant]
|
|
|
|
----
|
|
|
|
Sub ShouldNotBeEmpty()
|
|
|
|
DoSomething()
|
|
|
|
End Sub
|
|
|
|
|
|
|
|
Sub NotImplementedYet()
|
|
|
|
Throw New NotImplementedException
|
|
|
|
End Sub
|
|
|
|
|
|
|
|
Sub WillNeverBeImplemented()
|
|
|
|
Throw New NotSupportedException
|
|
|
|
End Sub
|
|
|
|
|
|
|
|
Sub EmptyOnPurpose()
|
|
|
|
' Do nothing because of X
|
|
|
|
End Sub
|
|
|
|
----
|
|
|
|
|
2021-06-03 09:05:38 +02:00
|
|
|
ifdef::env-github,rspecator-view[]
|
2021-09-20 15:38:42 +02:00
|
|
|
|
|
|
|
'''
|
|
|
|
== Implementation Specification
|
|
|
|
(visible only on this page)
|
|
|
|
|
2023-05-25 14:18:12 +02:00
|
|
|
=== Message
|
|
|
|
|
|
|
|
Add a nested comment explaining why this method is empty, throw a NotSupportedException or complete the implementation.
|
|
|
|
|
2021-09-20 15:38:42 +02:00
|
|
|
|
2021-06-08 15:52:13 +02:00
|
|
|
'''
|
2021-06-02 20:44:38 +02:00
|
|
|
== Comments And Links
|
|
|
|
(visible only on this page)
|
|
|
|
|
|
|
|
include::../comments-and-links.adoc[]
|
2023-06-22 10:38:01 +02:00
|
|
|
|
2021-06-03 09:05:38 +02:00
|
|
|
endif::env-github,rspecator-view[]
|