Interface name should begin with a 'I'
.NET interface names are commonly prefixed with an upper case I; this widely accepted convention is recommended. COM interfaces typically don't follow it, so interfaces tagged ComVisibleAttribute are not matched.
How to fix
Prefix matched interfaces names with an upper I.
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>Interface name should begin with a 'I'</Name>
// <Id>ND2002:InterfaceNameShouldBeginWithAI</Id>
// Don't query all Application.Types because some interface generated might not start with an 'I'
// like for example when adding a WSDL reference to a project.
warnif count > 0 from t in JustMyCode.Types where
t.IsInterface &&
// Don't apply this rule for COM interfaces.
!t.HasAttribute("System.Runtime.InteropServices.ComVisibleAttribute".AllowNoMatch())
// Discard outer type(s) name prefix for nested types
let name = !t.IsNested ?
t.Name :
t.Name.Substring(t.Name.LastIndexOf('+') + 1, t.Name.Length - t.Name.LastIndexOf('+') - 1)
where name[0] != 'I'
select new {
t,
Debt = 5.ToMinutes().ToDebt(),
Severity = Severity.High
}
//<Expl>
// The *{0}'s name* must begin with a **I**.
//</Expl>
//<Desc>
// .NET interface names are commonly prefixed with an upper case **I**; this
// widely accepted convention is recommended. COM interfaces typically don't
// follow it, so interfaces tagged *ComVisibleAttribute* are not matched.
//</Desc>
//<HowToFix>
// Prefix matched interfaces names with an upper **I**.
//</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