StyleCop(C#代码规范分析工具)---1.介绍,下载及配置

介绍

  StyleCop 是项目级别,开源免费,静态分析C#代码规范的工具,具有功能强大,简单易用,配置灵活等特点。StyleCop中内置的代码规范是根据.Net Framework 框架的设计原则来制定的!当然,你也可以创建自己的规则!StyleCop包括两个版本,一个是GUI版,一个是命令行。最新的StyleCop已经自动集成到VS2010当中,方便应用。

规则包括以下类别:

  • 文档(Documentation)
  • 布局(Layout)
  • 可维护性(Maintainability)
  • 命名(Naming)
  • 顺序(Ordering)
  • 可读性(Readability)
  • 间隔(Spacing)  

 

下载及配置

  StyleCop主页是:http://stylecop.codeplex.com/,可以在DownLoad下载最新版,当前最新版是4.7.17.0。下载的是个MSI文件直接双击运行,安装成功后,重新打开VS2010,在项目中右击项目名称,发现多了两个选择项(Run StyleCop和StyleCop Settings)。如图:

 

Run StyleCop

  会根据选择的规则,分析项目中的代码。如果你想分析某个文件或者某个文件夹下所有文件,可以直接在该文件或者文件夹上右击,在选择Run StyleCop即可。
分析完毕后会在 错误列表 中以警告的形式显示所有信息。

 

StyleCop Settings

  可以设置需要的规则。选择StyleCop Settings,可以打开如下对话框:


根据自己项目的需要,选择合适的规则。


 

转载于:https://www.cnblogs.com/usharei/archive/2012/03/30/2425214.html

StyleCop的终极目标是让所有人都能写出优雅和一致的代码,因此这些代码具有很高的可读性。 早就听说了微软内部的静态代码检查和代码强制格式美化工具 StyleCop StyleCop不是代码格式化(代码美化)工具,而是代码规范检查工具(Code Review 工具),它不仅仅检查代码格式,而是编码规范,包括命名和注释等。 StyleCop目的是帮助项目团队执行一系列常用的源代码格式规范,这些规范是关于如何开发布局规整,易读,易维护并且文档良好的优雅代码StyleCop 现在包含了 200 个左右的最佳实践规则(best practice rules),这些规则与 Visual Studio 2005 和 Visual Studio 2008 中默认的代码格式化规则是一致的。 StyleCop可以作为 Visual studio 的插件运行,在VS中对一个C#文件点击右键后的: 选择“Run StyleCop” 在VS执行后,执行效果如下: StyleCop也可以作为 MSBuild 任务(安装时有选项)通过命令行执行。 StyleCop只是一个代码格式的检查工具,它会根据预定义的C#代码格式的最佳实践,对我们的源代码进行检查,并给出不符合编码风格的错误提示。这一点来说与微软的另一个代码检查工具 FxCop 很相似,但 FxCop 是对 dll (compiled binaries) 进行检查,所以 FxCop 适用于新项目通过持续集成工具来使用的情况。也就是说 FxCop 是项目级别的,而 StyleCop代码级别的,更适合于程序员在编程过程中使用。 与 FxCop 的另一个不同是,SourceAnalysis StyleCop不提供灵活的规则设置,而是使用所谓 one-size-fits-all 的方式强制人们用同样的习惯书写代码,因此 SourceAnalysis (StyleCop)的终极目标是:The ultimate goal of Source Analysis is to allow you to produce elegant, consistent code that your team members and others who view your code will find highly readable. StyleCop检查的规则包括: 布局(Layout of elements, statements, expressions, and query clauses ) 括号位置(Placement of curly brackets, parenthesis, square brackets, etc ) 空格(Spacing around keywords and operator symbols ) 行距(Line spacing ) 参数位置(Placement of method parameters within method declarations or method calls ) 元素标准排列(Standard ordering of elements within a class ) 注释格式(Formatting of documentation within element headers and file headers ) 命名(Naming of elements, fields and variables ) 内置类型的使用(Use of the built-in types ) 访问修饰符的使用(Use of access modifiers ) 文件内容(Allowed contents of files ) Debugging文本(Debugging text)
StyleCop的终极目标是让所有人都能写出优雅和一致的代码,因此这些代码具有很高的可读性。 早就听说了微软内部的静态代码检查和代码强制格式美化工具 StyleCop StyleCop不是代码格式化(代码美化)工具,而是代码规范检查工具(Code Review 工具),它不仅仅检查代码格式,而是编码规范,包括命名和注释等。 StyleCop目的是帮助项目团队执行一系列常用的源代码格式规范,这些规范是关于如何开发布局规整,易读,易维护并且文档良好的优雅代码StyleCop 现在包含了 200 个左右的最佳实践规则(best practice rules),这些规则与 Visual Studio 2005 和 Visual Studio 2008 中默认的代码格式化规则是一致的。 StyleCop可以作为 Visual studio 的插件运行,在VS中对一个C#文件点击右键后的: 选择“Run StyleCop” 在VS执行后,执行效果如下: StyleCop也可以作为 MSBuild 任务(安装时有选项)通过命令行执行。 StyleCop只是一个代码格式的检查工具,它会根据预定义的C#代码格式的最佳实践,对我们的源代码进行检查,并给出不符合编码风格的错误提示。这一点来说与微软的另一个代码检查工具 FxCop 很相似,但 FxCop 是对 dll (compiled binaries) 进行检查,所以 FxCop 适用于新项目通过持续集成工具来使用的情况。也就是说 FxCop 是项目级别的,而 StyleCop代码级别的,更适合于程序员在编程过程中使用。 与 FxCop 的另一个不同是,SourceAnalysis StyleCop不提供灵活的规则设置,而是使用所谓 one-size-fits-all 的方式强制人们用同样的习惯书写代码,因此 SourceAnalysis (StyleCop)的终极目标是:The ultimate goal of Source Analysis is to allow you to produce elegant, consistent code that your team members and others who view your code will find highly readable. StyleCop检查的规则包括: 布局(Layout of elements, statements, expressions, and query clauses ) 括号位置(Placement of curly brackets, parenthesis, square brackets, etc ) 空格(Spacing around keywords and operator symbols ) 行距(Line spacing ) 参数位置(Placement of method parameters within method declarations or method calls ) 元素标准排列(Standard ordering of elements within a class ) 注释格式(Formatting of documentation within element headers and file headers ) 命名(Naming of elements, fields and variables ) 内置类型的使用(Use of the built-in types ) 访问修饰符的使用(Use of access modifiers ) 文件内容(Allowed contents of files ) Debugging文本(Debugging text)
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值