是否有自定义 FxCop 规则可以检测未使用的 PUBLIC 方法？

Posted 2023-02-21

【中文标题】是否有自定义 FxCop 规则可以检测未使用的 PUBLIC 方法？

【英文标题】：Is there a custom FxCop rule that will detect unused PUBLIC methods?

【发布时间】：2010-09-09 10:45:50

【问题描述】：

我刚试过 FxCop。它确实检测到未使用的私有方法，但未检测到未使用的公共方法。是否有我可以下载的自定义规则、插件来检测未从同一程序集中调用的公共方法？

【参考方案1】：

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 个专门用于未使用/死代码检测：

Potentially dead Types（因此检测未使用的类、结构、接口、委托...）

Potentially dead Methods

（因此检测未使用的方法、ctor、属性 getter/setter...） Potentially dead Fields

这些 CQLinq 代码规则比以前的 CQL 更强大。如果你点击上面这3个链接看这些规则的源代码，你会发现关于类型和方法的部分有点复杂。这是因为它们不仅检测未使用的类型和方法，还检测到仅被未使用的死类型和方法使用的类型和方法（递归）。

这是静态分析，因此规则名称中的前缀Potentially。如果代码元素仅通过反射使用，这些规则可能会将其视为未使用，但事实并非如此。

除了使用这 3 条规则之外，我还建议通过测试来衡量代码覆盖率，并努力实现全面覆盖。通常，您会看到测试无法覆盖的代码实际上是可以安全丢弃的未使用/死代码。这在不清楚代码分支是否可达的复杂算法中特别有用。

【参考方案2】：

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

如果未使用的公共方法导致 FxCop 警告，编写 API 等将是一件痛苦的事情 - 对于您打算让其他人使用的方法，您会收到大量 FxCop 警告。

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

如果您确实需要外部访问，请找出真正需要外部访问的方法，并将其余所有方法设置为内部访问。

您使外部可见的任何方法也可以进行单元测试。

【参考方案3】：

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

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

【讨论】：

我编辑了我的问题以使其更清晰。顺便说一句，我只对我的一个程序集感兴趣，一个 exe，而不是 dll。

【参考方案4】：

NDepend是你这种事情的朋友

【讨论】：

NDepend 很棒，但我看不出它如何检测未使用的公共方法。

@Ian Nelson：我在下面回复了如何使用 NDepend 来搜索这类东西。