是否有自定义FxCop规则来检测未使用的PUBLIC方法?

时间:2008-09-16 11:54:54

标签: .net code-analysis fxcop public-method

我刚试过FxCop。它确实检测未使用的私有方法,但不检测未使用的公共是否有可以下载的自定义规则,插件将检测未在同一程序集中调用的公共方法?

4 个答案:

答案 0 :(得分:15)

Corey,我使用FxCop的答案假设您有兴趣删除未使用的私有成员,但是为了解决其他情况下您可以尝试使用NDepend的问题。以下是一些用于检测未使用的公共成员的CQL(改编自下面列出的文章):

// <Name>Potentially unused methods</Name>
WARN IF Count > 0 IN SELECT METHODS WHERE
 MethodCa == 0 AND            // Ca=0 -> No Afferent Coupling -> The method 
                              // is not used in the context of this
                              // application.

 IsPublic AND                 // Check for unused public methods

 !IsEntryPoint AND            // Main() method is not used by-design.

 !IsExplicitInterfaceImpl AND // The IL code never explicitely calls 
                              // explicit interface methods implementation.

 !IsClassConstructor AND      // The IL code never explicitely calls class
                              // constructors.

 !IsFinalizer                 // The IL code never explicitely calls
                              // finalizers.

来源:Patrick Smacchia's "Code metrics on Coupling, Dead Code, Design flaws and Re-engineering。文章还讨论了检测死区和类型。

(编辑:回答更容易理解)


编辑2012年6月11日:解释有关未使用代码的新NDepend工具。免责声明:我是此工具的开发人员之一。

自2012年5月发布NDepend v4以来,该工具建议编写Code Rule over LINQ Query (CQLinq)。提议大约200 default code rules,其中3个专门用于未使用/死代码检测:

这些CQLinq代码规则比以前的CQL代码规则更强大。如果单击上面这三条链接指向这些规则的源代码,您将看到有关类型和方法的链接有点复杂。这是因为它们不仅检测未使用的类型和方法,还检测未使用的死类型和方法(递归)仅使用 的类型和方法。

这是静态分析,因此规则名称中的前缀可能。如果代码元素仅通过反射 使用,则这些规则可能会将其视为未使用,而不是这种情况。

除了使用这三条规则外,我还建议通过测试来测量代码覆盖率并努力实现全面覆盖。通常,您会看到测试无法覆盖的代码实际上是 unused / dead 代码,可以安全地丢弃。这在复杂的算法中尤其有用,因为不清楚代码的分支是否可达。

答案 1 :(得分:8)

如果方法未使用且公共FxCop假定您已将其公开以供外部访问。

如果未使用的公共方法导致FxCop警告编写API等会很痛苦 - 您会为其他人使用的方法收到大量FxCop警告。

如果您不需要任何外部访问程序集/ exe,请考虑使用public查找替换internal。您的应用程序将运行相同,FxCop将能够找到未引用的内部方法。

如果你确实需要外部访问,那么找到真正需要外部的方法,并将所有方法都放在内部。

您在外部看到的任何方法也可以进行单元测试。

答案 2 :(得分:3)

NDepend是你这种事的朋友

答案 3 :(得分:1)

如何知道公共方法未被使用?

通过将方法标记为公共方法,任何引用您的库的应用程序都可以访问该方法。