Fxcop 初体验

　　代码质量对于软件项目的成败很重要，这点我想大家都明白。那么在一个软件团队中如何保证代码质量呢？对于这个问题不同的人可能会有不同的答案，对于我而言我觉得做好两点代码质量基本就可以保证了：

　　1.代码规范（具体规范细则可以参考.NET 设计规范 一书）

　　2.测试（对于程序员本身而言主要是单元测试）

　　微软提供了 FoxCop 来检查代码规范

　　Nunit 来完成单元测试

 

　　对于Nunit 本博客已经有了一篇入门的文章，现在再来介绍 FxCop 的入门（由于个人的喜好，我不喜欢一些工具如SVN、NUnit等和VS集成，本文也不会弹 FxCop 与 VS的集成，但是网上这类文章很多，需要的读者自行搜索）

 

一、Fxcop 软件的安装

　　你可以从各种途径搞到FxCop 的安装包，我这里也提供 FxCop1.36 的下载

　　下载后按照提示安装，安装好后启动 FxCop

　　

 

二、检查程序集是否符合代码规范

Project --> Add Targets --> Analyze 如下图所示(在Rules Tab 中我们可以选择启用的规则)

 

三、自定义规则

1. 新建 类库项目加入 FxCop 1.36 安装目录下的 FxCopSdk.dll 和 Microsoft.Cci.dll

2. 新建 规则 xml，如下所示，并编译为资源

<?xml version="1.0" encoding="utf-8" ?>
<Rules FriendlyName="XXXSoft公司命名规范">
    <Rule TypeName="XXXSoftNameRuleMethod" Category="XXXSoft.NameRule" CheckId="XX0001">
        <Name>方法名规则</Name>
        <Description>方法名必须首字母大写，如果首字符小写将提示警告。</Description>
        <Url/>
        <Resolution>方法 “{0} ”的首字母应为大写</Resolution>
        <MessageLevel Certainty="99">Error</MessageLevel>
        <Email>yourMail@gmail.com</Email>
        <FixCategories>NonBreaking, DependsOnFix</FixCategories>
        <Owner>ServiceSoft</Owner>
    </Rule>

    <Rule TypeName="XXXSoftNameRuleField" Category="XXXSoft.NameRule" CheckId="XX0002">
        <Name>字段名规则</Name>
        <Description>字段的访问修饰符不能是公有的。</Description>
        <Url/>
        <Resolution>字段 “{0} ”的访问修饰符是public</Resolution>
        <MessageLevel Certainty="99">Error</MessageLevel>
        <Email>yourMail@gmail.com</Email>
        <FixCategories>NonBreaking, DependsOnFix</FixCategories>
        <Owner>ServiceSoft</Owner>
    </Rule>
</Rules>

3. 写规则类

using Microsoft.FxCop.Sdk;

namespace XXXCompanyRules
{
    public class FieldRule1 : BaseIntrospectionRule
    {
        public FieldRule1() :
            base("XXXSoftNameRuleField", "XXXCompanyRules.Rules", typeof(FieldRule1).Assembly)
        {}

        public override ProblemCollection Check(Member member)
        {
            if (member.DeclaringType is EnumNode)
            {
                return null;
            }
            Field field = member as Field;
            if (field == null)
            {
                return null;
            }
            if (field.IsPublic)
            {
                Problems.Add(new Problem(GetResolution(member.Name.Name)));
            }
            return Problems;
        }
    }
}

using System;
using Microsoft.FxCop.Sdk;

namespace XXXCompanyRules
{
    public class MethodRule1 : BaseIntrospectionRule
    {
        public MethodRule1() :
            base("XXXSoftNameRuleMethod", "XXXCompanyRules.Rules", typeof(MethodRule1).Assembly)
        { }

        /// <summary>
        /// 验证首字母
        /// </summary>
        /// <param name="member">类型成员</param>
        /// <returns>错误提示</returns>
        public override ProblemCollection Check(Member member)
        {
            Method method = member as Method;
            if (method == null)
            {
                return null;
            }
            if (!method.IsSpecialName && !Char.IsUpper(method.Name.Name, 0))
            {
                Problems.Add(new Problem(GetResolution(member.Name.Name)));
            }
            return Problems;
        }
    }
}

4. 编译生成 规则 dll

5. 添加到 FxCop 中

6. 验证

 

本节代码下载

 

本文完