使用StyleCop进行代码审查

        StyleCop analyzes C# source code to enforcea set of style and consistency rules. It can be run from inside of Visual Studio orintegrated into an MSBuild project 

        SourceAnalysis(StyleCop)不是代码格式化(代码美化)工具,而是代码规范检查工具(CodeReview 工具),它不仅仅检查代码格式,而是编码规范,包括命名和注释等。SourceAnalysis(StyleCop)目的是帮助项目团队执行一系列常用的源代码格式规范,这些规范是关于如何开发布局规整,易读,易维护并且文档良好的优雅代码的(help
teams enforce a common set of best practices for layout, readability,maintainability, and documentation of C# source code)。

        SourceAnalysis (StyleCop) 现在包含了 200 个左右的最佳实践规则(bestpractice rules),这些规则与 VisualStudio 2005 和  VisualStudio 2008 中默认的代码格式化规则是一致的。

  SourceAnalysis(StyleCop)可以作为 Visual studio 的插件运行.

  同时SourceAnalysis (StyleCop)也可以作为 MSBuild 任务(安装时有选项)通过命令行执行。

  SourceAnalysis(StyleCop)是代码级别的,更适合于程序员在编程过程中使用。

  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 findhighly readable.

  SourceAnalysis(StyleCop)检查的规则包括:

           布局(Layout of elements, statements,expressions, and query clauses )

           括号位置(Placement of curly brackets,parenthesis, square brackets, etc )

           空格(Spacing around keywords andoperator symbols )

          
行距(Line spacing )

           参数位置(Placement of method parameterswithin method declarations or method calls )

           元素标准排列(Standard ordering of elementswithin a class )

           注释格式(Formatting of documentationwithin element headers and file headers )

          
命名(Naming of elements, fields andvariables )

           内置类型的使用(Use of the built-in types )

           访问修饰符的使用(Use of access modifiers )

           文件内容(Allowed contents of files )

           Debugging文本(Debugging text)

        开始使用这些工具时可能会觉得对我们要求太苛刻,但根据微软自己的经验:aftera short adjustment period, they came to appreciate the rules enforced by SourceAnalysis, and even began to find it difficult to read
code not written in thisstyle.

         原文地址:原文地址

         工具下载地址:工具下载地址

使用图例如下:

时间: 2024-11-03 21:40:50

使用StyleCop进行代码审查的相关文章

代码审查工具StyleCop

"代码审查"或是"代码评审"(Code Review),这是一个流程,当开发人员写好代码后,需要让别人来review一下他的代码,这是一种有效发现BUG的方法.由此,我们可以审查代码的风格.逻辑.思路--,找出问题,以及改进代码.因为这是代码刚刚出炉的时候,所以,这也是代码重构,代码调整,代码修改的最佳时候.所以,Code Review是编码实现中最最重要的一个环节. 长时间以来,Code Review需要有一些有效的工具来支持,这样我们就可以更容易,更有效率地来进

C++编程规范直4:做代码审查

做代码审查 摘要:     代码审查:更多的关注有助于提高质量.两处自己的代码,阅读别人的代码.互相学习,彼此都会受益. 讨论: 好的代码审查能给团队开发带来的好处有: 1.      通过来自同伴的良性压力提高代码质量: 2.      找出错误.不可移植的代码(如果适用)和潜在的扩展问题. 3.      通过思想交流获得更好的设计和实现. 4.      快速培养新同事和入门者: 5.      在团队中形成共同的价值观和集体主义. 6.      增强整体实力,提升自信心.动力和职业荣誉

高效代码审查的十个经验

代码审查(Code Review)是软件开发中常用的手段,和QA测试相比,它更容易发现和架构以及时序相关等较难发现的问题,还可以帮助团队成员提高编程技能,统一编程风格等. 1. 代码审查要求团队有良好的文化 团队需要认识到代码审查是为了提高整个团队的能力,而不是针对个体设置的检查"关卡". "A的代码有个bug被B发现,所以A能力不行,B能力更好",这一类的陷阱很容易被扩散从而影响团队内部的协作,因此需要避免. 另外,代码审查本身可以提高开发者的能力,让其从自身犯过

代码审查工具 Crucible的使用方法

因为我们团队现在使用crucible来作为代码审查工具,所以我让同事去特地研究了下这个工具的使用方法,本文就是他研究的成果,我只是用中文重新翻译了下: 例子,比如叫Charles Wang的人去审查Kevin Qian的人写的代码. 对于作者Author: (1)登录代码审查页面主页. (2)点击"Create Review"按钮来创建一个代码审查事件,如下: (3)之后你会可以看到以下屏幕内容: 从这里可以看出,前面3个是用于"代码提交后"的审查.(我们基本采用这

在软件开发领域中代码审查是好事还是坏事

在软件开发领域,代码审查看起来是一个少有争议.相当平和的话题. 主流观点普遍认为代码审查是个好东西.有些公司或组织甚至强制要求把代码互审作为必须的流程. 审查是一种捕捉bug和问题的好措施.通过代码审查能够分享领域知识,提高代码质量.代码审查提供了一个对团队进行监控,教育和强化的好机会. 至少理论上是这样的- 当挽起袖子开干,当面对真正的项目计划产生的压力时,代码审查很有可能转而变成一件坏事. 审查是一种能够导致憎恨和分裂的活动.它能使人对编写的代码是否正确产生怀疑,会激起人们为他们自己的编码标

不做代码审查又怎样?

从一次回顾会议开始 "要不--我们不做--代码审查了--试试?"还记得当有人抛出这个建议时周围同学的表情,那种表情用两个字加两个标点符号就可以形容:"什么?!" 对了,先介绍一下背景,这是项目一次普通的回顾会议,我们正在讨论的是如何让代码审查更有效率和效果.我们做代码审查的方式比较简单直接,就是每日站会后,大家围在一台开发机周围,逐一轮换讲解昨天所有提交的内容,就像下图中的那样.还有,这是一个已经超过了7年的比较大型的项目,代码审查是我们从项目开始就坚持的一个实践,

论代码审查的重要性

[编者按]本文作者为 Hugo Giraudel,主要从各个角度论证了代码审查的重要性以及实现方法.文章系国内 ITOM 管理平台 OneAPM 编译呈现.以下为正文. 最近,笔者在Twitter上看到这样一句话: 可悲的是,对于很多学生.自由职业者以及机构来说,代码审查似乎相当陌生. 很明显,代码审查的重要性并不为每个人所熟知.你可以说我很天真,但是笔者确实认为所有的IT公司都离不开该过程.显然实际并非如此,真是让我大吃一惊. 在本文中,笔者想给出关于代码审查的想法,以及为什么我认为这是代码迁

建立更好的代码审查制度

本文讲的是建立更好的代码审查制度, 原文地址:Crafting Better Code Reviews 原文作者:本文已获原作者 Vaidehi Joshi 授权 译文出自:掘金翻译计划 译者:bobmayuze 校对者:SareaYu.吃土小2叉 建立更好的代码审查制度 来自 Rails 2017 开发者大会中的一段演讲 人与科技之间的交互部分总是那么忽明忽暗,难以捉摸.对于开发科技产品的人来说,更是如此.作为一个资深码农,我在代码审查的时候对于这一点的感触特别明显. 大多数开发者们习惯于把他

《C++编程规范:101条规则、准则与最佳实践》——1.5做代码审查

1.5做代码审查 摘要 审查代码:更多的关注有助于提高质量.亮出自己的代码,阅读别人的代码.互相学习,彼此都会受益. 讨论 好的代码审查过程对开发团队有许多好处. 通过来自同伴的良性压力提高代码质量. 找出错误.不可移植的代码(如果适用)和潜在的扩展问题. 通过思想交流获得更好的设计和实现. 快速培养新同事和入门者. 在团队中形成共同的价值观和集体主义. 增强整体实力,提升自信心.动力和职业荣誉感. 许多开发单位现在既不奖励高质量的代码和高质量的团队,也不投入时间和资金予以鼓励.我们估计几年之内