CA1714: Flags enums should have plural names
TypeName |
FlagsEnumsShouldHavePluralNames |
CheckId |
ca1714 |
Category |
Microsoft.Naming |
تعطيل تغيير |
فصل |
السبب
يحتوي قائمة تعداد عام System.FlagsAttributeواسمه فلا إنهاء الخاص في '.
وصف القاعدة
أنواع عليها FlagsAttributeلها أسماء يتم جمع لأن السمة يشير إلى أن المزيد واحد يمكن أن يتم تعيين القيمة. على سبيل المثال، قائمة تعداد التي تعرف أيام أسبوع التي قد تكون موجهة للاستخدام في تطبيق الموقع يمكنك تحديد عدة أيام. وهذا قائمة تعداد يجب أن يكون لديك FlagsAttributeوقد يسمى 'ايام'. قائمة تعداد مشابهة التي تسمح ليوم مفرد فقط إلى يمكن تحديد قد لا يكون لديك السمة، وقد يكون هناك يسمى 'يوم'.
اصطلاحات التسمية يوفر نظرة عامة مكتبات هذا الهدف وقت تشغيل اللغة العامة. وهذا يقلل من المنحنى التعليم المطلوب لمكتبات البرامج الجديدة، و يزيد من ثقة العميل المكتبة تم تطويره من قبل الشخص الذي لديه خبرة في تطوير تعليمات برمجية المدارة.
كيف إلى الإصلاح انتهاكات
جعل اسم التعداد الجمع الكلمة، أو قم بإزالة FlagsAttributeالسمة إذا كان يجب أن لا يتم تعيين قيم التعداد متعددة في نفس الوقت.
عند إلى منع التحذيرات
أمان إلى على منع حدوث انتهاك في حالة الاسم هو كلمة جمع ولكن لا ينتهي في الشركة '. ل مثال، في حالة التعداد مضاعف يوم تم وصفها مسبقاً تم المسمى 'DaysOfTheWeek'، هذا هو تخالف منطق للقاعدة ولكن ليس له هدف. يجب أن يكون مثل انتهاكات suppressd.
القواعد ذات الصلة
ca1027: وضع علامة تتضمن التعدادات مع FlagsAttribute
ca2217: لا تضع علامة تعدادات مع FlagsAttribute