플래그 열거형에는 복수형 이름을 사용해야 합니다.
업데이트: 2007년 11월
TypeName |
FlagsEnumsShouldHavePluralNames |
CheckId |
CA1714 |
범주 |
Microsoft.Naming |
변경 수준 |
주요 변경 |
원인
public 열거형에 System.FlagsAttribute가 있고 이름이 's'로 끝나지 않았습니다.
규칙 설명
FlagsAttribute 특성은 둘 이상의 값을 지정할 수 있음을 나타내므로 이 특성으로 표시된 형식은 복수형 이름을 갖습니다. 예를 들어 요일을 정의하는 열거를 여러 날짜를 지정할 수 있는 응용 프로그램에서 사용하려는 경우 이 열거에는 FlagsAttribute가 있어야 하며 'Days'라는 이름을 지정할 수 있습니다. 이와 비슷하지만 하루만 지정할 수 있는 열거는 이 특성을 포함할 수 없으며 'Day'라는 이름을 지정할 수 있습니다.
명명 규칙은 공용 언어 런타임을 대상으로 하는 라이브러리에 공통적인 모양을 적용합니다. 이 라이브러리는 관리 코드 개발에 대한 전문 지식을 가진 사람에 의해 개발되었으므로 새 소프트웨어 라이브러리에 익숙해지는 데 필요한 학습 기간을 단축하고 고객의 신뢰를 높여 줍니다.
위반 문제를 해결하는 방법
열거 이름을 복수형 단어로 만들거나, 여러 열거 값을 동시에 지정할 수 없는 경우에는 FlagsAttribute 특성을 제거합니다.
경고를 표시하지 않는 경우
이름이 복수 단어이지만 's'로 끝나지 않는 경우에는 경고를 표시하지 않아도 안전합니다. 예를 들어 앞서 설명한 여러 날짜를 지정하는 열거의 이름이 'DaysOfTheWeek'이었다면 이 이름은 규칙의 논리를 위반하지만 의도된 것이 아닙니다. 이러한 위반은 표시하지 않아야 합니다.
관련 규칙
열거형을 FlagsAttribute로 표시하지 마십시오.