Microsoft.StyleCop

时间:2013-02-09 17:35:07
【文件属性】:
文件名称:Microsoft.StyleCop
文件大小:1.34MB
文件格式:MSI
更新时间:2013-02-09 17:35:07
StyleCop C#代码规范工具 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)

网友评论

  • 资料不错,感谢分享!!有点太重了
  • 具体地说,这其实是一个严格的语法检查器。有点太繁琐。
  • 软件可以用,检查的很详细,我没用好 ,不知道怎么配置,有些太详细了,比如说每个代码文件都要求有head注释,太繁琐了,而且编译的时候发现速度明显慢了好多,不过还是谢谢您的分享,工具本身是没问题的