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.
76 lines
1.4 KiB
Plaintext
76 lines
1.4 KiB
Plaintext
== Why is this an issue?
|
|
|
|
This rule raises an issue when an externally visible enumeration is marked with ``++FlagsAttribute++`` and one, or more, of its values is not a power of 2 or a combination of the other defined values.
|
|
|
|
|
|
=== Noncompliant code example
|
|
|
|
[source,csharp]
|
|
----
|
|
using System;
|
|
|
|
namespace MyLibrary
|
|
{
|
|
[Flags]
|
|
public enum Color // Noncompliant, Orange is neither a power of two, nor a combination of any of the defined values
|
|
{
|
|
None = 0,
|
|
Red = 1,
|
|
Orange = 3,
|
|
Yellow = 4
|
|
}
|
|
}
|
|
----
|
|
|
|
|
|
=== Compliant solution
|
|
|
|
[source,csharp]
|
|
----
|
|
using System;
|
|
|
|
namespace MyLibrary
|
|
{
|
|
public enum Color // Compliant - no FlagsAttribute
|
|
{
|
|
None = 0,
|
|
Red = 1,
|
|
Orange = 3,
|
|
Yellow = 4
|
|
}
|
|
|
|
[Flags]
|
|
public enum Days
|
|
{
|
|
None = 0,
|
|
Monday = 1,
|
|
Tuesday = 2,
|
|
Wednesday = 4,
|
|
Thursday = 8,
|
|
Friday = 16,
|
|
All = Monday| Tuesday | Wednesday | Thursday | Friday // Compliant - combination of other values
|
|
}
|
|
}
|
|
----
|
|
|
|
|
|
ifdef::env-github,rspecator-view[]
|
|
|
|
'''
|
|
== Implementation Specification
|
|
(visible only on this page)
|
|
|
|
=== Message
|
|
|
|
Remove the "FlagsAttribute" from this enum.
|
|
|
|
|
|
=== Highlighting
|
|
|
|
Primary: Enum declaration
|
|
|
|
Secondaries: Enum values that are raising the issue
|
|
|
|
|
|
endif::env-github,rspecator-view[]
|