C#编码规范-使用StyleCop进行代码格式检查

前言

但是在项目开发的过程中，如果只是验证命名规则、而没有统一程序排版，不同开发人员将产出不同的文件格式。这样的产出，虽然能够正常地提供项目功能 ，但缺会大幅降低了这份程序代码的可维护性与可读性。

本篇文章介绍如何通过StyleCop这个工具，来自动分析代码格式，在不增加开发人员负担的前提下，让团队的程序代码产出趋于一致、大幅提高程序代码的生产质量。

一、安装

安装完成后重启vs。

二、使用

1. 右键菜单项目
   

Run StyleCop执行代码分析。
StyleCop Settings 设置规则，如下图：

三、不建议采纳的代码规范

一、文档规则

29. SA1628:DocumentationTextMustBeginWithACapitalLetter  注释节点内部的文本必须以大写字母开头
30. SA1629:DocumentationTextMustEndWithAPeriod  注释节点内部的文本必须英文的句号结束
31. SA1630:DocumentationTextMustContainWhitespace  注释节点内部的文本必须包含空格
32. SA1631:DocumentationMustMeetCharacterPercentage 注释节点内部的文本中不能包含过多的字符(举例:包含’---------------------------------------’是不允许的) //不一定，类似这种不需要的可以自己手动删除这个规范
33.  SA1632:DocumentationTextMustMeetMinimumCharacterLength  已经作废的规则，不允许有太短的字符串(如’A name’ 中的A字母)
34.  SA1633:FileMustHaveHeader   代码文件头部必须有说明，一般放置版权信息
35. SA1634:FileHeaderMustShowCopyright  代码文件头部注解中必须包含版权关键字
36. SA1635:FileHeaderMustHaveCopyrightText代码文件头部注解中必须包含版权信息内同
37. SA1636:FileHeaderCopyrightTextMustMatch  代码文件头部注解中版权信息必须与设置画面设置的内容相匹配，在”style seting”画面的” CompanyInformation tab”进行设置
38. SA1637:FileHeaderMustContainFileNam