集成开发环境的配置及使用说明

集成开发环境的配置及使用说明

本文讲解如何编写MSBuild脚本文件执行编译系统、运行FxCop检查代码、运行NUnit以及NCover进行单元测试、运行SandCastle生成帮助文档四项功能，并如何在集成开发环境中使用。

一、集成开发环境的配置

1.1 工具软件准备

1.1.1 MSBuild

只要安装过VS2005或VS2008后，就可以是路径C:\WINDOWS\https://www.360docs.net/doc/1612406565.html,\Framework中看到MSBuild的三人版本，本例中使用V3.5。另外还得从下面的网站下载一个https://www.360docs.net/doc/1612406565.html,munity.Tasks.msi文件，里面有MSBuild的已经编写好的各种任务。下载地址如下：

https://www.360docs.net/doc/1612406565.html,/

1.1.2 NCover

NCover现有网上使用的主要有两个版本NCover3.1和NCover1.5.8，但由于后者是免费版本，所以本例中使用NCover1.5.8版本，下载地址如下：https://www.360docs.net/doc/1612406565.html,/download/community

1.1.3 其它软件

其它软件如下所示：

NUnit 2.5.1

FxCop 1.36

HTML Help Compiler

Sandcastle Help File Builder v 1.8.0.2

以上包括1.1.1和1.1.2的软件均可在Redmine项目管理的集成开发环境的配置的文件管理中下载，此处就不一一给链接了。下载后均按默认安装即可。但因为要在命令行中使用MSBuild和FxCopcmd命令，所在在环境变量Path中加入：

C:\WINDOWS\https://www.360docs.net/doc/1612406565.html,\Framework\v3.5;

C:\Program Files\Microsoft FxCop 1.36;

另外再增加两个新变量：

DXROOT C:\Program Files\Sandcastle和

HHCEXE C:\Program Files\HTML Help Workshop

1.2 编写MSBuild脚本文件

关于MSBuild的常用脚本元素之前已在《MSBuild的简单介绍与使用》中说过，这里就不再重复了，只针对每一功能的重要语句进行讲解，详情可以Redmine 项目管理的集成开发环境的配置中下载MyProj.proj文件进行查看。

1.2.1 编译系统

脚本文件如下所示：

Targets="$(BuildTargets)"

Properties="RunCodeAnalysis=$(RunCodeAnalysis)" >

ItemName="CodeAssemblies"/>

其中参数如下：

Projects：必选的ITaskItem[] 参数。指定要生成的项目文件。

Properties：可选的String 参数。以分号分隔的属性名称/值对列表，这些属性名称/值对将作为全局属性应用于子项目。当使用MSBuild.exe 生成项目时，指定此参数在功能上等效于设置具有/property 开关的属性。例如：Properties ="Configuration=Debug;Optimize=$(Optimize)"

通过Properties 参数向项目传递属性时，即使已加载项目文件，MSBuild 也会创建该项目的一个新实例。创建项目的新实例后，MSBuild 会将其视为具有不同的全局属性并且可与该项目的其他实例并行生成的不同项目。例如，“发布”配置可与“调试”配置同时生成。

Targets：可选的String 参数。指定要在项目文件中生成的一个或多个目标。使用分号分隔目标名称列表。如果MSBuild 任务中未指定目标，将会生成项目文件中指定的默认目标。

Output元素的参数含义如下：

TaskParameter：必需。任务输出参数的名称。

PropertyName：PropertyName 或ItemName 属性是必需的。接收任务输出参数值的属性。此后，项目可以使用$(PropertyName) 语法引用该属性。此属性名称可以是新的属性名称，也可以是已经在项目中定义的名称。如果ItemName 还在使用，则不能使用此属性。

ItemName：PropertyName 或ItemName 属性是必需的。接收任务输出参数值的项。此后，项目可以使用@(ItemName) 语法引用该项。该项的名称可以是新的项名称，也可以是已经在项目中定义的名称。如果PropertyName 还在使用，则不能使用此属性。

1.2.2运行FxCop检查代码

在https://www.360docs.net/doc/1612406565.html,munity.Tasks中本来有编译好的FxCop任务，但此处由于FxCop版本问题，不能使用，故仍使用MSBuild的Exec任务来集成FxCop检查代码。脚本如下：

/project:@(FxCopFile)导入已生成好的.FxCop文件（FxCop文件的生成在后边的集成环境的使用项目准备中会详细讲解）

/out:$(DocFolder)\$(FxCopResults)指定将要生成的FxCop结果文件

1.2.3运行NUnit进行单元测试

https://www.360docs.net/doc/1612406565.html,munity.Tasks中包含已编写好的NUnit任务，此处只要直接添加任务并配置参数即可，其中详细参数可以参看https://www.360docs.net/doc/1612406565.html,munity.Tasks自带的帮助文档，脚本文件如下所示：

ToolPath="$(NUnitPath)"

WorkingDirectory="%(CodeAssemblies.RootDir)%(CodeAssemblies.Directory)"

OutputXmlFile="@(TestProjects->'%(RootDir)%(Directory)bin\$(Configuration)\$(NUni

tFile)')"

ContinueOnError="true">

Assemblies：导入MSBuild任务编译生成的结果（即项目的应用程序集）

ToolPath：NUnit的安装路径

WorkingDirectory：MSBuild任务编译生成的结果（即项目的应用程序集）所在的目录

OutputXmlFile：指定输入的xml结果文件

ContinueOnError：指如果出错后是否继续执行

1.2.4运行NCover检查NUnit覆盖率

因为NCover1.5.8版本不支持https://www.360docs.net/doc/1612406565.html,munity.Tasks中已编写好的NCover任务，所以只能用Exec任务来完成。，NCove脚本文件如下：

因为单独使用NCover.Console命令执行会弹出项目应用程序集的对话框（如果有的话）,所以此处与NUnit一块使用来避免（如果不阻止的话，后边在将编写好的MSBuild集成到ccnet时会发生超时退出，因为无法关闭项目应用程序集

的对话框）。

%22$(NUnitCmd)%22：导入NUnit-console.exe命令

The /noshadow option disables shadow copying of the assembly in

order to provide improved performance.

%22@(CodeAssemblies)%22：导入MSBuild任务编译生成的结果（即项目的应用程

序集）

//l $(CodeCoverFolder)\$(NCoverLogFile)：指定生成的coverage.log文件

//x $(CodeCoverFolder)\$(NCoverFile)：指定生成的结果文件coveragel.xml

1.2.5运行SandCastle生成帮助文档

因为没有编写好的SandCastle任务，所以此处仍然用Exec任务来集成，脚

本文件如下：

$(DOUBLE_QUOTES)$(MSBuildCmd)$(DOUBLE_QUOTES)：导入MSBuildCmd命令

$(DOUBLE_QUOTES)@(SandCastleHFBProject)$(DOUBLE_QUOTES)：导入已生成好的.shfbproj

文件（使用Sandcastle Help File Builder生成，后边详细讲解如何生成）。

1.2.6清除垃圾文件

在任务结果时应该将中间生成的无用文件进行删除，如下所示：

"@(TestProjects->'%(RootDir)%(Directory)bin\$(Configuration)\*$(NUnitFile)');

@(TestProjects->'%(RootDir)%(Directory)bin\$(Configuration)\*$(LastTestRunSuc

ceededFile)');

@(TestProjects->'%(RootDir)%(Directory)bin\$(Configuration)\*.bkp')">

先将无用的文件用CreatItem集合成一个Item，然后用Delete进行删除即可。

二、集成开发环境的使用

本集成环境的文件结构目录如下所示：

其中e:ccnet为ccnet的工作目录，456为其中的一个工程目录，code里存放所有的代码，此目录与SVN服务器保存的代码进行同步，Documentation目录下存放生成好的各项结果文件。

2.1 新建项目（项目准备）

打开VS2008新建一个项目（此处项目命名为msbtest），添加一个新测试类class1，代码如下：

using System;

using System.Collections.Generic;

using System.Linq;

using System.Text;

using NUnit.Framework;

namespace MSBuildTest

{

[TestFixture]

class Class1

{

private int a;

private int b;

[SetUp]

public void InitializeOperands()

{

a = 1;

b = 2;

}

[Test]

public void AddTwoNumbers()

{

int sum = a + b;

Assert.AreEqual(sum, 3);

}

[Test]

public void MultiplyTwoNumbers()

{

int product = a * b;

Assert.AreEqual(2, product);

}

}

}

Class1主要为测试NUnit和NCover用，可以根据实际需要添加。另需在References中添加nunit.framework。

在c#项目中鼠标右键点击所选的项目，在显示的菜单中选择Properties选项，打开Properties Page，鼠标左键点击Build项，在显示的页面中勾选XML documentation file。如下图所示：

一般新建项目后，均会在vs2008的默认路径中的Projects中保存一个解决方案文件和一个同名代码目录，如下图所示：

点选解决方案，然后在file->save msbtest.sln as…将项目解决方案文件另存在同名代码目录中，这样做一方面在之后与SVN同步时不容易出错，另一方面便于在msbuild脚本文件中对文件目录进行控制。

最后再编译运行一次即可。

然后将所本环境所提供的test文件夹放至E:\ccnet目录下，将test目录重新命名为msbtest，然后把上面所说的同名代码目录文件夹中的所有文件复制到E:\ccnet\msbtest的code目录下。如下图所示：

2.1.1生成.FxCop文件

若第一次使用FxCop，请先在vs2008中External Tools添加FxCop，方法如下：

In V isual Studio select Tools->External Tools…Y ou should see the External Tools dialog box.

Y ou must fill following fields:

Title: FxCop

Command: C:\Program Files\Microsoft FxCop 1.36\FxCopCmd.exe

Arguments: /c /p:"$(SolutionDir)\$(SolutionFileName).fxcop" /cXsl:"C:\Program Files\Microsoft FxCop 1.36\Xml\VSConsoleOutput.xsl"

Initial Directory: C:\Program Files\Microsoft FxCop 1.36

Use output window Must be checked

If you install FxCop in different location than C:\Program Files\Microsoft FxCop 1.36, you need

to use your own path.

In case you want to grok the switches we use, you can read more about FxCopCmd options.

然后打开FxCop GUI界面，在My FxCop Project中通过”Add Targets”添加E:\ccnet\msbtest\code\bin\Debug下的要分析应用程序集，如下图所示：

这个就是我们增加以后的内容：

设置Targets以后，可以选定需要的规则，我们一般不需要Globalization和Security的规则，所以可以从规则库中将两者去除。

然后将项目文件保存至解决方案文件所在的目录下，并且保存名称为解决方案全称加“.FxCop”，本例中为msbtest.sln.FxCop，如下图所示：

这样即可在vs2008中通过Tools->FxCop直接检测，也可以在后续集成至MSBuild中时使用msbtest.sln.FxCop文件。

2.1.2生成.shfbproj文件

打开Sandcastle Help File Builder，新建一个工程，名称随便，本例仍为msbtest。在Documentation Sources中添加E:\ccnet\msbtest\code\msbtest.sln文件，在Referencesk中把项目中所引用到的dll文件（nunit.framework）加载进去，之后在左侧Project Properties按下列进行配置：

1. 设置FrameworkV ersion为3.5

2. 设置HtmlHelp1xCompilerPath为HTML Help Workshop的安装路径

3. 设置SandcastlePath为Sandcastle的安装路径

4. 保存该项目后点击Namespaces按钮，选中想要生成帮助文档的Namespace

然后将项目保存至E:\ccnet\msbtest\Documentation\Help路径下，文件名为msbtest.shfbproj（其实此处文件名可以随意，因为在MSBuild中集成时是自动匹配此路径下的.shfbproj文件）。

2.2 使用集成环境执行检测

编辑E:\ccnet\msbtest\c-msbuild.cmd，将原文件修改为：

MSBuild E:\ccnet\msbtest\MyProj.proj

pause

最后双击c-msbuild.cmd即可执行，执行结果如下所示：

编译结果：

Fxcop

Nunit

Ncover

SandCastle

CleanSolution

对应的结果可在下列目录中进行查看，这里就不一一演示了。

注册msbuild fxcopxmd