rspec/rules/S1186/csharp/rule.adoc

60 lines
1.1 KiB
Plaintext
Raw Normal View History

== Why is this an issue?
2020-06-30 12:47:33 +02:00
There are several reasons for a method not to have a method body:
2021-02-02 15:02:10 +01:00
2020-06-30 12:47:33 +02:00
* It is an unintentional omission, and should be fixed.
2021-01-27 13:42:22 +01:00
* It is not yet, or never will be, supported. In this case a ``++NotSupportedException++`` should be thrown.
2020-06-30 12:47:33 +02:00
* The method is an intentionally-blank override. In this case a nested comment should explain the reason for the blank override.
=== Noncompliant code example
2020-06-30 12:47:33 +02:00
2022-02-04 17:28:24 +01:00
[source,csharp]
2020-06-30 12:47:33 +02:00
----
public override void DoSomething()
{
}
public override void DoSomethingElse()
{
}
----
=== Compliant solution
2020-06-30 12:47:33 +02:00
2022-02-04 17:28:24 +01:00
[source,csharp]
2020-06-30 12:47:33 +02:00
----
public override void DoSomething()
{
// Do nothing because of X and Y.
}
public override void DoSomethingElse()
{
throw new NotSupportedException();
}
----
=== Exceptions
2020-06-30 12:47:33 +02:00
The following methods are ignored:
2021-01-27 13:42:22 +01:00
* empty ``++virtual++`` methods,
* empty methods that override an ``++abstract++`` method,
2020-06-30 12:47:33 +02:00
* empty overrides in test assemblies.
ifdef::env-github,rspecator-view[]
'''
== Implementation Specification
(visible only on this page)
include::../message.adoc[]
'''
== Comments And Links
(visible only on this page)
include::comments-and-links.adoc[]
endif::env-github,rspecator-view[]