16f6c0aecf
Inline adoc files when they are included exactly once. Also fix language tags because this inlining gives us better information on what language the code is written in.
72 lines
1.8 KiB
Plaintext
72 lines
1.8 KiB
Plaintext
== Why is this an issue?
|
|
|
|
``++System.Collections.Generic.List<T>++`` is a generic collection that is designed for performance and not inheritance. For example, it does not contain virtual members that make it easier to change the behavior of an inherited class. That means that future attempts to expand the behavior will be spoiled because the extension points simply aren't there. Instead, one of the following generic collections should be used:
|
|
|
|
* ``++System.Collections.Generic.IEnumerable<T>++``
|
|
* ``++System.Collections.Generic.IReadOnlyCollection<T>++``
|
|
* ``++System.Collections.Generic.ICollection<TKey>++``
|
|
* ``++System.Collections.Generic.IReadOnlyList<T>++``
|
|
* ``++System.Collections.Generic.IList<TKey>++``
|
|
* ``++System.Collections.ObjectModel.Collection<T>++``
|
|
* ``++System.Collections.ObjectModel.ReadOnlyCollection<T>++``
|
|
* ``++System.Collections.ObjectModel.KeyedCollection<TKey, Titem>++``
|
|
|
|
This rule raises an issue every time a ``++System.Collections.Generic.List<T>++`` is exposed:
|
|
|
|
* As an externally visible member.
|
|
* As the return type of an externally visible method.
|
|
* As a parameter type of an an externally visible method.
|
|
|
|
|
|
=== Noncompliant code example
|
|
|
|
[source,csharp]
|
|
----
|
|
namespace Foo
|
|
{
|
|
public class Bar
|
|
{
|
|
public List<T> Method1(T arg) // Noncompliant
|
|
{
|
|
//...
|
|
}
|
|
}
|
|
}
|
|
----
|
|
|
|
|
|
=== Compliant solution
|
|
|
|
[source,csharp]
|
|
----
|
|
namespace Foo
|
|
{
|
|
public class Bar
|
|
{
|
|
public Collection<T> Method1(T arg)
|
|
{
|
|
//...
|
|
}
|
|
}
|
|
}
|
|
----
|
|
|
|
|
|
ifdef::env-github,rspecator-view[]
|
|
|
|
'''
|
|
== Implementation Specification
|
|
(visible only on this page)
|
|
|
|
=== Message
|
|
|
|
Refactor this [method|field|property] to use a generic collection designed for inheritance.
|
|
|
|
|
|
=== Highlighting
|
|
|
|
The generic list declaration
|
|
|
|
|
|
endif::env-github,rspecator-view[]
|