rspec/rules/S1186/csharp/rule.adoc

48 lines
996 B
Plaintext
Raw Normal View History

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
----
public override void DoSomething()
{
}
public override void DoSomethingElse()
{
}
----
== Compliant Solution
----
public override void DoSomething()
{
// Do nothing because of X and Y.
}
public override void DoSomethingElse()
{
throw new NotSupportedException();
}
----
== Exceptions
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::rspecator-view[]
== Comments And Links
(visible only on this page)
include::comments-and-links.adoc[]
endif::rspecator-view[]