标签：Code 读书笔记 Analyzers 代码 Clean 规则 NET 整洁 StyleCop
一、关于Bob大叔的Clean Code
《代码整洁之道》主要讲述了一系列行之有效的整洁代码操作实践。软件质量，不但依赖于架构及项目管理，而且与代码质量紧密相关。这一点，无论是敏捷开发流派还是传统开发流派，都不得不承认。这本书的阅读对象为一切有志于改善代码质量的程序员，书中介绍的规则均来自作者Bob大叔多年的实践经验，涵盖从命名到重构的多个编程方面，虽为一“家”之言，然诚有可资借鉴的价值。
最让我感受深刻的是封面图片和副标题，首先是封面图片：
上面这张图是M104：草帽星系，其核心是一个质量超大的黑洞，有100万个太阳那么重，环绕着M104的光环就像一顶墨西哥草帽，仿佛经历了大爆炸之后碎片四溅的产物。联系到我们所经历过的没由整洁代码风格各异不可维护的软件项目，其实当你接手时之前的代码都是一个个的黑洞，存在着某天会定时爆发的风险，而当它真正爆发时，接手这个项目的所有人都会因此遭殃。
其次，再说说副标题：“细节之中自有天地，整洁成就卓越代码”。本书讲述的就是一个又一个的细节之处，不好的处理和好的处理都一一道来，让我们形成整洁的规范。
Robert C. Martin，(Bob大叔)自1970年进入软件行业，从1990年起成为国际软件咨询师。是软件工程领域的大师级人物，是《敏捷软件开发：原则、模式与实践》、《敏捷软件开发：原则、模式与实践(C#版)》（邮电）、《极限编程实践》（邮电）等国内引进的畅销书的作者，其中第一本原著荣获美国《软件开发》第13届震撼（Jolt）大奖，Martin的敏捷系列书是软件工程界的权威书籍。
二、Clean Code精华笔记
文不如表，表不如图，奉上一张思维导图：
三、.NET平台的代码规范插件使用
3.1 StyleCop.Analyzers介绍
StyleCop.Analyzers是一个开源的代码风格规则的审查项目，其github地址为：https://github.com/DotNetAnalyzers/StyleCopAnalyzers，用于.NET编译器平台的StyleCop分析器，该存储库包含使用.NET编译器平台的StyleCop规则的实现。 在可能的情况下，还会提供代码修复以简化纠正违规的过程。
它具有以下几个好处：
- 可以支持 C# 6
- 使用 Roslyn 解析器，减少了自定义解析器的性能消耗
- 当你写代码的时候解析器就会运行，当你编译的时候也会运行（不需要再设置 msbuild 任务或者安装任何 vs 插件）
最近我们团队就采用了StyleCop.Analyzers作为代码审查插件，并将重要的规则设定为了Error级别，即如果你不改正编译不会通过。其实，Resharper也是一款不错的工具，但是因为其收费和重量级的特性，被我放弃了。
3.2 StyleCop.Analyzers安装
为需要进行代码风格审查的.NET项目Nuget上直接搜索：StyleCop.Analyzers即可，目前最新版本为1.0.2.
3.3 设置规则列表
这里我分享一个我们团队筛选过后的Ruleset文件（点我下载），它将作为StyleCop.Analyzers的分析基准，我一般将其放在解决方案的Solution Items中，即解决方案层级中（和Dockerfile类似放在项目层级中）
3.4 编辑具体项目的项目文件（csproj）
为每个需要进行代码风格/规则审查的项目指定需要基准的Ruleset文件：（通过编辑项目文件）
3.5 测试代码风格检查
写了一些代码之后，编译，查看错误信息窗口：
可以看到未满足代码规则的点都被检查出来，只有改正之后才可以编译通过。
最后，再次回顾一下《代码整洁之道》的副标题：
“细节之中自有天地，整洁成就卓越代码”
参考资料
Robert C.Martin著，《代码整洁之道》
soulless, 《C# 代码规范和质量检查工具 StyleCop.Analyzers》
DotNetAnalyzers，《Using StyleCop Analyzers with .NET Core》
转载自http://www.cnblogs.com/edisonchou/
标签：Code,读书笔记,Analyzers,代码,Clean,规则,NET,整洁,StyleCop 来源： https://www.cnblogs.com/wangsea/p/15904155.html
本站声明： 1. iCode9 技术分享网（下文简称本站）提供的所有内容，仅供技术学习、探讨和分享； 2. 关于本站的所有留言、评论、转载及引用，纯属内容发起人的个人观点，与本站观点和立场无关； 3. 关于本站的所有言论和文字，纯属内容发起人的个人观点，与本站观点和立场无关； 4. 本站文章均是网友提供，不完全保证技术分享内容的完整性、准确性、时效性、风险性和版权归属；如您发现该文章侵犯了您的权益，可联系我们第一时间进行删除； 5. 本站为非盈利性的个人网站，所有内容不会用来进行牟利，也不会利用任何形式的广告来间接获益，纯粹是为了广大技术爱好者提供技术内容和技术思想的分享性交流网站。