我刚试过 FxCop。它确实检测到未使用的私有方法,但未检测到未使用的公共方法。是否有我可以下载的自定义规则,插件将检测未从同一程序集中调用的公共方法?
4 回答
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 的“关于耦合、死代码、设计缺陷和重新设计的代码指标。文章还讨论了检测死字段和类型。
(编辑:使答案更容易理解)
编辑 2012 年 6 月 11 日:解释有关未使用代码的新 NDepend 设施。免责声明:我是这个工具的开发者之一。
自 2012 年 5 月 NDepend v4 发布以来,该工具提出了编写代码规则 over LINQ Query (CQLinq)。提出了大约200 条默认代码规则,其中 3 条专用于未使用/死代码检测:
这些 CQLinq 代码规则比以前的 CQL 更强大。如果你点击上面这3个链接查看这些规则的源代码,你会发现关于类型和方法的部分有点复杂。这是因为它们不仅检测未使用的类型和方法,还检测仅由未使用的死类型和方法(递归)使用的类型和方法。
这是静态分析,因此规则名称中的前缀可能是。如果仅通过反射使用代码元素,则这些规则可能会将其视为未使用,但事实并非如此。
除了使用这 3 条规则之外,我还建议通过测试来衡量代码覆盖率并争取完全覆盖。通常,您会看到测试无法覆盖的代码实际上是可以安全丢弃的未使用/死代码。这在不清楚代码分支是否可达的复杂算法中特别有用。
如果一个方法未被使用并且公共 FxCop 假定您已将其公开以供外部事物访问。
如果未使用的公共方法导致 FxCop 警告,编写 API 之类的东西会很痛苦 - 对于您打算让其他人使用的方法,您会收到大量的 FxCop 警告。
如果您不需要任何外部的东西来访问您的程序集/exe,请考虑public
使用internal
. 您的应用程序将运行相同,FxCop 将能够找到未引用的内部方法。
如果您确实需要外部访问,请找出真正需要外部访问的方法,并将其余所有方法设置为内部。
您使外部可见的任何方法也可以进行单元测试。
NDepend是你这种事情的朋友
它怎么知道公共方法未被使用?
通过将方法标记为公共的,任何引用您的库的应用程序都可以访问它。