自定义StyleCop规则
参考:StyleCopSDK.chm与 Byeah的 编写StyleCop自定义规则教程(一)---编写中文备注的简单校验规则
1.建立“类库”类型的C#项目
2.加入 Microsoft.StyleCop.dll 与 Microsoft.StyleCop.CSharp.dll 的引用
3.增加一个类,继承于:SourceAnalyzer,并带有 [SourceAnalyzer(typeof(CsParser))] 标题头。
4.重写AnalyzeDocument方法
5.使用WalkDocument遍历代码,并执行指定的方法
6.建立与类同名的XML文件
编译,生成 DLL
放到C:\Program Files\Microsoft StyleCop 4.3
打开VS2008,即可让规则生效
编号定义:飞鹏替换规则为 FP+原编号,飞鹏新规则为 FPN+100开始的编号
已生效的,VS2008 打开的情况下,就不能删除了。(以前认为已生效的,要失效一次,再生效一次,是不是CACHE造成的误解)
如何调试?
生成,拷贝到stylecop目录,启动VS2008,执行 StyleCop
在生成后事件命令行输入如下内容会方便很多:
copy "$(TargetDir)$(TargetName).*" "C:\Program Files\Microsoft StyleCop 4.3" /y
element 这个对象必须非常熟悉
代码如果没有变更,检测也是假的,调试不会中断。要把使用 cache 关掉
=====跟踪
[证明是错的]如果已被系统检查了,就不会产生中断了。(例如 SA1623开启时,FP1623就不会中断)
VS2008打开时,原来注册的,现在却无法取消
VS产生的XML文件格式与记事本产生的有一些不同(都是 UTF-8)
XML是包含在DLL的资源中,而不是分成两个文件
代码分析:
执行 WalkDocument 时,StyleCop 调用 CodeWalker<T>.Start(静态方法)
(反射工具有一个错误:查找 CodeWalker.Start 的 User By 时,只找到 CSharp.Expression.WalkExpression 调用它,实际上 CsDocument类 的 WalkDocument 方法也有调用)
Start时,创立一个 CodeWalker 实例。
创立实例时,又执行 this.WalkElement
WalkElement里面代码如下:
private bool WalkElement(CsElement element, CsElement parentElement, T context)
{
if (element != null)
{
// 元素不为空时
// 第一次调用时,context 为空
T local = context;
if (!this.VisitElement(element, parentElement, ref local))
{
// 查看元素,返回 false 时
return false;
}
foreach (Statement statement in element.ChildStatements)
{
// 对元素的每一个表达式进行检查
if (!this.WalkStatement(statement, null, null, element, local))
{
return false;
}
}
foreach (CsElement element2 in element.ChildElements)
{
// 对元素的每一个子类进行检查
if (!this.WalkElement(element2, element, local))
{
return false;
}
}
}
// 返回 true,让下一个子类检查得以继续
return true;
}
第一次进入时,元素即 CsDocument.RootElement(Namespace{}),
VisitElement里面代码如下:
private bool VisitElement(CsElement element, CsElement parentElement, ref T context)
{
if (this.elementCallback != null)
{
return this.elementCallback(element, parentElement, context);
}
return true;
}
elementCallback 就是我们自己写的子程序了。
现在的担心,如果我们写的代码没有像原规则那样考虑那么多问题,怎么办?
不过,反射工具可以提供内部所有代码:
装载 Microsoft.StyleCop.CSharp.Rules.dll
先搜索 AnalyzeDocument (它的做法与我们的做法是一样的)找到DocumentationRules的那个(因为 SA1603在DocumentationRules中)
Microsoft.StyleCop.CSharp.DocumentationRules.AnalyzeDocument(CodeDocument) : Void
里面有一个代码:
this.CheckElementDocumentation(document2);
中间也是用 WalkDocument
document.WalkDocument<AnalyzerSettings>(new CodeWalkerElementVisitor<AnalyzerSettings>(this.CheckDocumentationForElement), context);
注册的内容为:CheckDocumentationForElement,点下去,
对于属性,它有:this.CheckHeader(element, settings, false);
接着对于有头内容的,它执行: this.ParseHeader(element, element.Header, element.LineNumber, partialElement);
ParseHeader,对属性的处理代码如下:
else if (element.ElementType == ElementType.Property)
{
this.CheckPropertyValueTag(element, doc);
this.CheckPropertySummaryFormatting(element as Property, doc);
}
这时,进入关键的代码:CheckPropertySummaryFormatting
这个就是网页中(http://www.cnblogs.com/Byeah/archive/2011/06/27/2091222.html)体现的代码,放心了,我们的代码就是抄它的。
自定义StyleCop规则的更多相关文章
- MVC系列——MVC源码学习:打造自己的MVC框架(三:自定义路由规则)
前言:上篇介绍了下自己的MVC框架前两个版本,经过两天的整理,版本三基本已经完成,今天还是发出来供大家参考和学习.虽然微软的Routing功能已经非常强大,完全没有必要再“重复造轮子”了,但博主还是觉 ...
- struts2 自定义校验规则
自定义校验规则:(了解) 在Struts2自定义校验规则: 1.实现一个Validator 接口. 2.一般开发中继承ValidatorSupport 或者 FieldValidatorSupport ...
- yii2中自定义验证规则rules
作者:白狼 出处:www.manks.top/article/yii2_custom_rules 本文版权归作者,欢迎转载,但未经作者同意必须保留此段声明,且在文章页面明显位置给出原文连接,否则保留追 ...
- CI 框架中的自定义路由规则
在 CI 框架中,一个 URL 和它对应的控制器中的类以及类中的方法是一一对应的,如: www.test.com/user/info/zhaoyingnan 其中 user 对应的就是控制器中的 us ...
- easyui的validatebox重写自定义验证规则的几个实例
validatebox已经实现的几个规则: 验证规则是根据使用需求和验证类型属性来定义的,这些规则已经实现(easyui API): email:匹配E-Mail的正则表达式规则. url:匹配URL ...
- 自定义 Lint 规则简介
上个月,笔者在巴黎 Droidcon 的 BarCamp 研讨会上聆听了 Matthew Compton 关于编写自己的 Lint 规则的讲话.深受启发之后,笔者想就此话题做进一步的探索. 定义 如果 ...
- 在ubuntu16.04中安装apache2+modsecurity以及自定义WAF规则详解
一.Modsecurity规则语法示例 SecRule是ModSecurity主要的指令,用于创建安全规则.其基本语法如下: SecRule VARIABLES OPERATOR [ACTIONS] ...
- Scarpy 起始url 自定义代理 自定义去重规则
- start_urls - 内部原理 """ scrapy引擎来爬虫中去起始的URL: 1. 调用start_requests并获取返回值 2. v = iter(返回 ...
- zabbix添加对自定义无规则的关键日志文件的监控
zabbix添加对自定义无规则日志文件的监控 项目背景及思路: zabbix自带有针对日志文件的监控,自带的监控只能监控到指定文件或者正则匹配的固定日志文件,但当需要监控的文件名没有规律的时候自带监控 ...
随机推荐
- c# 高效读写文件
一.同步读写文件(在并发情况下不会发生文件被占用异常) static void Main(string[] args) { Parallel.For(0, 10000, e => { strin ...
- Windows 8.1 应用开发后台任务概述(Windows XAML)
说到后台任务,这是在和许多 Android 开发者聊天的时候,经常被提起的话题之一, Windows 移动平台的后台任务的形式有别与 Android 的后台 service,简单的说在 Windows ...
- (译)开发优秀的虚拟现实体验:从开发I Expect You to Die中总结的六个要点
这篇文章是我从网上找来的,我觉得他非常详细的解释了VR发展的需求和必要.我认为通过这篇文章可以让大家了解VR. 译者写在最前: 来到追光动画有好几个月了,抱歉这段时间也没有什么文章与大家分享,我现在在 ...
- 最值得收藏的Bootstrap资源网站
如果你正在寻找Bootstrap图标,那今天的推荐对你而言绝对非常重要!在这篇内容中,我们把这套框架上的免费字体图 标做了个整合(当然,以后还会不断的更新).正如你所知,图标字体在一个web网页设计拥 ...
- 25款顶级的jQuery表格插件
jQuery 表格插件可以让你创建各种各样的表格布局,表格布局是报纸和杂志中最常见的布局,现在的网站中也很常见,在这篇文章中,我向大家推荐25个jQuery 的表格插件,你可以任意控制表格的行和列,用 ...
- Kafka重复消费和丢失数据研究
Kafka重复消费原因 底层根本原因:已经消费了数据,但是offset没提交. 原因1:强行kill线程,导致消费后的数据,offset没有提交. 原因2:设置offset为自动提交,关闭kafka时 ...
- GUID全局唯一标识符相关知识了解
全局唯一标识符(GUID,Globally Unique Identifier)是一种由算法生成的二进制长度为128位的数字标识符.GUID主要用于在拥有多个节点.多台计算机的网络或系统中.在理想情 ...
- XCode自动打ipa包脚本 命令
XCode 新建文件 选择other Shell script 放入下面命令行. #工程绝对路径 #cd $ project_path=$(pwd) #build文件夹路径 build_path=$ ...
- Javascript入门学习
编程之道,程序员不仅仅要精通一门语言,而是要多学习几门. 本学习之源出自柠檬学院http://www.bjlemon.com/,特此声明. 第一课1:javascript的主要特点解释型:不需要编译, ...
- JAVA学习绘图颜色及其笔画属性设置字体显示文字
package com.graphics; import java.awt.*; import java.awt.geom.Rectangle2D; import java.util.Date; im ...