【颗粒归仓】(四)代码走查工具---StyleCop
一、StyleCop是什么?
StyleCop是代码规范检查工具(Code Review 工具),它不仅仅检查代码格式,而是编码规范,包括命名和注释等。开源是这个工具最大的特点!
二、应用场景
StyleCop是微软公司开发的一款应用,可以在vs中作为插件进行代码走查,也可以集成到MSBuild中进行代码走查,主要针对C#代码进行走查。
StyleCop可以检查代码中的各类静态编程规范错误,从代码注释,代码布局,可维护性,命名规范,可读性等各方面对代码规范性进行检查。重要的是,其规则可以自定义,可以屏蔽掉不适用于特定项目的规则,甚至可以自定义开发适用于各自项目的规则。
三、安装使用
官网:http://stylecop.codeplex.com/ ,下载最新版本V4.7.54支持在VS2012、vs2013中进行安装使用。
(1)初始安装过程默认选择”Visual Studio integration”,即作为VS的插件来使用,如图:
(2)安装成功之后,打开VS,在“解决方案管理器”中右击需要走查的项目,如图:单击"Run StyleCop"
(3)在“错误列表”窗口中将会对该”类or项目”中不符合预设代码风格的地方以“警告”的形式标出,如图:
(4)针对错误列表中给出的信息进行规范化改进,当然对于规范的限制,可以手动进行筛选以及设定,如图:
自定义设置编码规则,将专门用一篇博客来介绍。
四、检查规则
• 布局(Layout ofelements, statements, expressions, and query clauses )
• 括号位置(Placement ofcurly brackets, parenthesis, square brackets, etc )
• 空格(Spacing aroundkeywords and operator symbols )
• 行距(Line spacing )
• 参数位置(Placement ofmethod parameters within method declarations or method calls )
• 元素标准排列(Standardordering of elements within a class )
• 注释格式(Formatting ofdocumentation within element headers and file headers )
• 命名(Naming ofelements, fields and variables )
• 内置类型的使用(Use of thebuilt-in types )
• 访问修饰符的使用(Use ofaccess modifiers )
• 文件内容(Allowed contentsof files )
• Debugging文本(Debuggingtext)
StyleCop从以上12个方面对C#代码进行走查,它会根据预定义的200多个C#代码格式的最佳实践(编码规范),对我们的源代码进行检查,并给出不符合编码风格的错误提示。
StyleCop这个工具能够带给我的不仅仅是合作开发时代码规范整洁一致,对于初级程序员来说,形成自己的编码风格要比前者的收获更大。
【颗粒归仓】(四)代码走查工具---StyleCop相关推荐
- 代码走查工具篇FxCop的规则总结与翻译_Part2
续接上篇:代码走查工具篇FxCop的规则总结与翻译_Part1 Globalizationrules(区域性规则) 1. AvoidDuplicateAccelerators CA1301 避免快捷 ...
- 访问Oracle数据库的四款工具软件介绍
本文由Markdwon语法编辑器编辑完成. 1. Oracle数据库介绍: 关于Oracle数据库,以及它和MySQL, SQL Server等其他数据库的介绍和区别,可以查看以下来自知乎的链接. h ...
- GIS二次开发:实验四 编辑工具条的实现
实验四 编辑工具条的实现 一.实验目的 1.熟悉arcgis中的编辑工具 2.掌握通过arcgis engine 的toolbarcontrol添加编辑工具条 3.掌握自定义工具条的添加 二.实验仪器 ...
- 实验四 自动化测试工具-软件测试
湖北汽车工业学院实验报告 实验四 自动化测试工具 按照上述实验步骤完成利用Junit对Calculator类测试过程,将异常测试.参数化测试等测试类方法的运行结果截图保证在下面. 2.采用QTP对W ...
- Python 项目管理与构建,这四款工具足够了!
作者:隔叶黄莺 来源:https://yanbin.blog/python-dependency-management-build-tools Python 历时这么久以来至今还未有一个事实上标准的项 ...
- 代码审查工具StyleCop
"代码审查"或是"代码评审"(Code Review),这是一个流程,当开发人员写好代码后,需要让别人来review一下他的代码,这是一种有效发现BUG的方法. ...
- 【JTeam Champion NFT】NFT交易必备的四个工具
NFT交易必备工具介绍 首先NFT交易必备的工具有:Mintysocre.NFTGo.NFTNerds.Icy.tools这四种. Mintysocre Mintysocre作用是可以快速发现热门项目 ...
- C# 代码规范和质量检查工具 StyleCop.Analyzers
简介 原来一直用 ReSharper 来进行代码质量检查,不过毕竟是收费的,所以想找个免费的可以推广给公司的同事也一起用.搜索了一下,找到了StyleCop,但是我在 VS 2015里安装 Style ...
- 平面设计实验四 绘制工具和修饰工具
一.实验目的: 通过实验,了解Photoshop各种绘制工具和修饰工具的操作:理解绘制和修饰工具的使用范围和使用方法. 二.实验器材: 硬件:计算机 软件:Photoshop CC 三.试验方法与步骤 ...
- Markdown(四)——绘图工具mermaid之状态图stateDiagram
前言:在做软件工程时经常会需要用到绘图来帮助理解软件构造,CSDN的编辑器集成了插入绘图工具mermaid,以下是对其常用语法的一些记录整理 状态图 以下是学习mermaid语法的官网:https ...
最新文章
- 【剑指offer-Java版】42翻转单词顺序VS左旋转字符串
- 界面原型创建工具Axure 基本操作
- Mac下安装的MySQL root账号无法登陆用户解决
- 【机器学习基础】理解关联规则算法
- linux下常用压缩格式的压缩与解压方法
- AI面试必备!你不可不知的10个深度学习方法
- OpenCV3学习笔记二:图像的掩膜操作
- 解决xib自定义tableFooterView一个神奇的bug
- apache web_Web发明家预测文化将发生变化,Apache推动一半的互联网发展,等等
- 分层模型中数据传输过程
- oracle 判断最后一笔_美股道琼斯日线杀跌一笔结束,向上一笔的反弹顺理成章。又到金秋弯腰拾金时...
- 配置docker加速器
- 将你的掘金小册制作成一整本PDF
- mac接收gmail邮件_如何从您的Gmail帐户发送和接收Hotmail
- 第46届EC-Final总结
- 调查显示:SD-WAN部署迅猛增长,MPLS不会消失
- 2018年第九届蓝桥杯B组第四题:摔手机题解
- 【代数语言学巡礼】Lambda-演算在形式语义学的中应用II
- 屏幕旋转后字体会变大问题
- Android Google登录接入