Visual Studio 代码分析 - 创建新规则来计算方法中的行数

Question

更新

我反映了 Microsoft.Cci.dll 并构建了我的规则。效果很好。但是，我遇到了一些问题，我把 此处包含所有详细信息。源代码是 这里。我不想通过添加所有细节来增加这个问题的长度。

我正在尝试编写一个代码分析规则，该规则会对具有以下特征的方法发出警告： 超过100行。我正在关注 这篇文章。但是，我无法按照CodeAnalysis提供的API来计算行数。例如，

public override ProblemCollection Check(Member member)
        {
            Method method = member as Method;
            if (method == null)
            {
                return null;
            }
            CheckForLOC(method);
            return Problems;
        }

以下是 CheckForLOC()

private void CheckForLOC(Method method)
    {
        int startLineForMethod = method.Body.SourceContext.StartLine;
        int endLineForMethod = method.Body.SourceContext.EndLine;
        if (endLineForMethod > startLineForMethod
            && ((endLineForMethod - startLineForMethod) > constMaximumLOCforAMethod))
        {
            Resolution resolution = GetResolution(method, constMaximumLOCforAMethod);
            Problem problem = new Problem(resolution);
            Problems.Add(problem);
        }
    }

在上面的代码中，method.Body.SourceContext.StartLine 和 method.Body.SourceContext.EndLine 返回相同的值。不知道为什么。

我还尝试使用 StatementCollection ：-

private void CheckForLOC(Method method)
        {
            int LOCPerMethod = 0;

            if (method.Body.Statements.Count >= 1)
            {
                foreach (var statement in method.Body.Statements)
                {
                    LOCPerMethod += GetNumberOfLinesPerStatement(statement);
                }

            }
            if (LOCPerMethod > constMaximumLOCforAMethod)
            {
                Resolution resolution = GetResolution(method, constMaximumLOCforAMethod);
                Problem problem = new Problem(resolution);
                Problems.Add(problem);
            }
        }

        private int GetNumberOfLinesPerStatement(Statement statement)
        {
            int LOCperStatement = 0;
            if (statement.SourceContext.EndLine > statement.SourceContext.StartLine)
            {
                LOCperStatement = statement.SourceContext.EndLine - statement.SourceContext.StartLine;
            }
            return LOCperStatement;
        }

这里，Statement.SourceContext.StartLine 和 Statement.SourceContext.EndLine 返回相同的值。我看到每个语句的 StartLine 都不同，需要从前一个语句的 StartLine 值中减去一个语句的 StartLine 值。但是，我发现结果不稳定。例如，在下面的方法片段中，它给出了 Statement1 的行号作为 StartLineNumber，而它应该给出 If(SomeCondition) 的 StartLineNumber：-

if(SomeCondition)
{
   Statement1
   Statement2
   Statement3
}

有人可以对此提供一些指导吗？

Answer 1

这更像是一种样式规则，而不是正确性规则，因此它比 FxCop 规则更适合 StyleCop 规则。

也就是说，如果您确实想通过 FxCop 实现它，您应该看看 Microsoft.FxCop.Sdk.MethodMetrics.CalculateLinesOfCode(Method) 如何完成相同的任务。

Answer 2

NDepend 工具支持任何 .NET 语言的指标 NbLinesOfCode。此外，它还集成在 Visual Studio 2012、2010、2008 中。免责声明：我是该工具的开发人员之一

您要求...

创建新规则来计算方法中的行数

使用 NDepend，您可以编写 基于 LINQ 查询的代码规则 (即CQLinq）。因此，创建一个新规则来计算方法中的行数，可以像编写...一样简单

warnif count > 0 
from m in JustMyCode.Methods
where m.NbLinesOfCode > 10
orderby m.NbLinesOfCode descending 
select new { m, m.NbLinesOfCode }

，并在 Visual Studio 中立即获得结果。只需双击结果中的方法即可跳转到代码中的方法声明：

周围 默认建议 200 个默认 CQLinq 代码查询和规则。

Answer 3

我一直在寻找相同的方法（以获取方法中的总行数），并且找到了解决方案。

下面是示例：

public override ProblemCollection Check(Member member)
    {
        Method method = member as Method;
        if (method != null)
        {
            **if (method.Metrics.ClassCoupling > 20)**
            {
                Resolution resolu = GetResolution(new string[] { method.ToString() });
                Problems.Add(new Problem(resolu));
            }
        }
        return Problems;
    }

您可以尝试 method.Metrics.ClassCoupling 来获取方法的总行数。