Attribute class name should be suffixed with 'Attribute'
Warns about attribute classes not suffixed with Attribute, a common .NET practice.
How to fix
Suffix the names of matched attribute classes with Attribute.
CQLinq source
This rule is written in CQLinq, C# LINQ over the NDepend code model. It ships with every new NDepend project: you can read it, adapt it, or use it as a starting point for your own custom rules.
// <Name>Attribute class name should be suffixed with 'Attribute'</Name>
// <Id>ND2005:AttributeClassNameShouldBeSuffixedWithAttribute</Id>
warnif count > 0 from t in Application.Types where
t.IsAttributeClass &&
// We use SimpleName, because in case of generic Attribute type
// SimpleName suppresses the generic suffix (like <T>).
!t.SimpleNameLike(@"Attribute$") &&
!t.SimpleNameLike(@"AttributeBase$") // Allow the second suffix Base
// for base attribute classes.!t.SimpleName.EndsWith(@"Attribute")
select new {
t,
Debt = 5.ToMinutes().ToDebt(),
Severity = Severity.High
}
//<Expl>
// The *attribute {0}'s name* should be suffixed with *Attribute*.
//</Expl>
//<Desc>
// Warns about *attribute classes* not suffixed with **Attribute**, a common
// .NET practice.
//</Desc>
//<HowToFix>
// Suffix the names of matched attribute classes with **Attribute**.
//</HowToFix>
Open in the interactive Rules Explorer · All default rules
Naming Conventions: all 23 items
- Instance fields naming convention ND2000
- Static fields naming convention ND2001
- Interface name should begin with a 'I' ND2002
- Abstract base class should be suffixed with 'Base' ND2003
- Exception class name should be suffixed with 'Exception' ND2004
- Attribute class name should be suffixed with 'Attribute' ND2005
- Types name should begin with an Upper character ND2006
- Methods name should begin with an Upper character ND2007
- Do not name enum values 'Reserved' ND2008
- Avoid types with name too long ND2009
- Avoid methods with name too long ND2010
- Avoid fields with name too long ND2011
- Avoid having different types with same name ND2012
- Avoid prefixing type name with parent namespace name ND2013
- Avoid naming types and namespaces with the same identifier ND2014
- Don't call your method Dispose ND2015
- Methods prefixed with 'Try' should return a boolean ND2016
- Properties and fields that represent a collection of items should be named Items. ND2017
- DDD ubiquitous language check ND2018
- Avoid fields with same name in class hierarchy ND2019
- Avoid various capitalizations for method name ND2020
- Controller class name should be suffixed with 'Controller' ND2021
- Nested class members should not mask outer class' static members ND2022