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.
46 lines
954 B
Plaintext
46 lines
954 B
Plaintext
== Why is this an issue?
|
|
|
|
If an ``++enum++`` member's name contains the word "reserved" it implies it is not currently used and will be change in the future. However changing an ``++enum++`` member is a breaking change and can create significant problems. There is no need to reserve an ``++enum++`` member since a new member can be added in the future, and such an addition will usually not be a breaking change.
|
|
|
|
|
|
This rule raises an issue when the name of an enumeration member contains "reserved".
|
|
|
|
|
|
=== Noncompliant code example
|
|
|
|
[source,csharp]
|
|
----
|
|
using System;
|
|
|
|
namespace MyLibrary
|
|
{
|
|
public enum Color
|
|
{
|
|
None,
|
|
Red,
|
|
Orange,
|
|
Yellow,
|
|
ReservedColor // Noncompliant
|
|
}
|
|
}
|
|
----
|
|
|
|
|
|
ifdef::env-github,rspecator-view[]
|
|
|
|
'''
|
|
== Implementation Specification
|
|
(visible only on this page)
|
|
|
|
=== Message
|
|
|
|
Remove or rename this enum member.
|
|
|
|
|
|
=== Highlighting
|
|
|
|
Enum member
|
|
|
|
|
|
endif::env-github,rspecator-view[]
|