Don't call your method Dispose

Rule ND2015 Naming Conventions

How to fix

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>Don't call your method Dispose</Name>
// <Id>ND2015:DontCallYourMethodDispose</Id>

warnif count > 0

// Activate this rule only when IDisposable is resolved in third-party code
// else this rule might produce false positives.
let thirdPartyDisposable = ThirdParty.Types.WithFullName("System.IDisposable").FirstOrDefault()
where thirdPartyDisposable != null

from m in JustMyCode.Methods.WithSimpleName("Dispose")
where !m.ParentType.Implement("System.IDisposable".AllowNoMatch()) 
   &&  m.OverriddensBase.Count() == 0    // Can't change the name of an override
   && !m.IsNewSlot  // new slot also means override of an interface method 
select new {
   m,
   Debt = 15.ToMinutes().ToDebt(),
   Severity = Severity.High
}

//<Expl>
// The parent type of the *{0}* doesn't implement the *IDisposable* interface.
// You should either implement it or rename this method using a different 
// identifier, such as:: *Close() Terminate() Finish() Quit() Exit() Unlock() ShutDown()*…
//</Expl>

//<Desc>
// The identifier *Dispose* should be kept for *System.IDisposable*
// implementations. Warns when a method named *Dispose()* belongs to a type
// not implementing *System.IDisposable*.
//</Desc>

//<HowToFix>
// Either implement *System.IDisposable* on the parent type, or rename the
// method, e.g. *Close() Terminate() Finish() Quit() Exit() Unlock()
// ShutDown()*…
//</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