场景
StyleCop可以检查代码中的各类静态编程规范错误，从代码注释、代码布局、可维护性、命名规范、可读性等各个方面对代码规范性进行检查
其主要目的是为了规范代码,也可用来进行代码审查
是什么
StyleCop 是一个代码规范化的检查工具，检查的规范如下
- 文档规则： 验证源文件中的文档元素的适用性
- 布局规则： 验证源文件中的布局和行距
- 可维护性规则： 验证源文件的可维护性方面，例如，不需要的括号或单个文件中存在多个类
- 命名规则：验证方法和变量名称的可替代性
- 排序规则：验证代码内容是否正确培训
- 可读性规则：验证代码是否格式正确且可读。
- 间距规则：验证代码内容中的间距是否有效且适当
为什么
StyleCop 将 源文件作为一个文档，将源文件中的代码作为元素，Stylecop针对文档和元素进行静态检查
文件.png
文件与代码.png
怎么样
StyleCop 可以帮助开发者在编码的时候时刻注意编码规范，提升代码 可读性、可维护性等，提升代码质量。
遵守可以帮助团队实现统一规则的编码规范。
使用
1.VS
官方下载安装文件并安装，用vs打开项目，右击项目，就可以看到以下菜单，
StyleCop菜单.png
2. Resharper
首先安装StyleCop，安装Resharper插件，通过Resharper的扩展管理下载StyleCop
Resharper扩展菜单.png
Resharper StyleCop.png
安装成功后，Resharper会对不满足StyleCop的代码进行规范验证
3.默认规则
4.可过滤规则
- SA1600：元素必须添加注释
- SA1614：参数注释节点里不能空着，
举例: /// <param></param> ,注释中的参数标签为空 - SA1616：返回值注释的节点内必须有文本值，
举例: /// <return></return> ,注释中的返回标签为空 - SA1623：属性的注释必须与属性的读写权限匹配，private类型的属性不能出现在注释里
- SA1630：注释节点内部的文本必须包含空格
- SA1631：注释节点内部的文本中不能包含过多的字符
举例:包含’---------------------------------------’是不允许的) - SA1650：注释不能有拼写错误
对中文支持不友好 - SA1633：代码文件头部必须有说明，一般放置版权信息
- SA1309：字段名不能以下滑线开头
- SA1310：字段名不能包括下滑线
- SA1311：static与readonly字段首字母大写
学习网址
相关产品
CodeRush：一个VS的插件，能够为用户有更好的提示。
FxCop：一个微软免费的静态代码分析框架。
StyleCop：分析c#源代码执行一组风格和一致性规则。它可以运行在微软VS或集成到一个MSBuild项目。
我的公众号
我的公众号
网友评论