rspec/rules/S1939/csharp/rule.adoc

54 lines
1.1 KiB
Plaintext
Raw Normal View History

== Why is this an issue?
2020-06-30 12:47:33 +02:00
An inheritance list entry is redundant if:
2021-01-27 13:42:22 +01:00
* It is ``++Object++`` - all classes extend ``++Object++`` implicitly.
* It is ``++int++`` for an ``++enum++``
2020-06-30 12:47:33 +02:00
* It is a base class of another listed inheritance.
Such redundant declarations should be removed because they needlessly clutter the code and can be confusing.
=== 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 class MyClass : Object // Noncompliant
enum MyEnum : int // Noncompliant
----
=== 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 class MyClass
enum MyEnum
----
ifdef::env-github,rspecator-view[]
'''
== Implementation Specification
(visible only on this page)
=== Message
"yyy" implements "xxx" so "xxx" can be removed from the inheritance list.
"Object" should not be explicitly extended.
"int" should not be explicitly used as the underlying type.
'''
== Comments And Links
(visible only on this page)
=== on 16 May 2016, 17:01:45 Ann Campbell wrote:
\[~tamas.vajk] messages should be directive, not statements of fact.
include::../comments-and-links.adoc[]
endif::env-github,rspecator-view[]