rspec/rules/S1186/csharp/rule.adoc

60 lines
1.1 KiB
Plaintext

== Why is this an issue?
There are several reasons for a method not to have a method body:
* It is an unintentional omission, and should be fixed.
* It is not yet, or never will be, supported. In this case a ``++NotSupportedException++`` should be thrown.
* The method is an intentionally-blank override. In this case a nested comment should explain the reason for the blank override.
=== Noncompliant code example
[source,csharp]
----
public override void DoSomething()
{
}
public override void DoSomethingElse()
{
}
----
=== Compliant solution
[source,csharp]
----
public override void DoSomething()
{
// Do nothing because of X and Y.
}
public override void DoSomethingElse()
{
throw new NotSupportedException();
}
----
=== Exceptions
The following methods are ignored:
* empty ``++virtual++`` methods,
* empty methods that override an ``++abstract++`` method,
* 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[]