C#编程规范工具介绍

 1、目标

代码编写规范、整齐、整洁、可读。

无错误

无警告

2、排版

安装PowerCommands扩展

“工具”-“扩展管理库”,搜索安装。

设置选中Format document on save和Remove and Sort Usings on save

这样代码保存时会自动格式化和对引用单元排序。

3、注释

设置工程“属性” – “生成” – “输出”

选中 “XML文档文件(X)”

目的为了提示每个公共可见类型的注释。

4、代码分析优化重构

ReSharper

代码分析

ReSharper可提供对C#, XAML, XML, ASP.NET和ASP.NET MVC的持续的代码质量分析,甚至在用户对之进行编译以前即可检测到错误和问题。ReSharper可对用户的代码提供900多种代码检验,用户便可即刻 察觉到其当前文件或者甚至整个解决方案中是否包含了错误和故障。

高亮显示错误和快速修正

ReSharper能在用户输入的时候即对代码进行分析,并高亮显示错误,用户甚至无需进行编译。其甚至能对大部分错误快速给出修改建议,以帮助用户快速解决问题。

代码重构

与Visual Studio 2005/2008/2010相比,ReSharper提供了更丰富的自动代码重构功能。用户可使用许多不同的重构方法以进行重命名,移动,安全删除标识;导入和内联字段、变量和参数等等

右侧提示黄色感叹号三角,以及黄色线条,选中修改。正确后提示绿色打勾方块。

5、代码检查

StyleCop

StyleCop的终极目标是让所有人都能写出优雅和一致的代码,因此这些代码具有很高的可读性。StyleCop不是代码格式化(代码美化)工具,而是代码规范检查工具(Code Review 工具),它不仅仅检查代码格式,而是编码规范,包括命名和注释等。它会根据预定义的C#代码格式的最佳实践,对我们的源代码进行检查,并给出不符合编码风格的错误提示。

工程文件,点击鼠标右键,选择“Run StyleCop (Rescan All)”

显示警告列表”

规则编号以SA开头,例如“SA1305”可以查找相应的规则,根据规则进行修改。消除所有警告。

6、总结

上述工具运用后的代码如果没有错误和警告,代码质量应该是还可以的,选一两个项目运用工具检查一遍,

对照华为编程规范,发现有很多都是能对上的。博文发的不多,希望对大家有用。

时间: 2024-10-12 15:02:14

C#编程规范工具介绍的相关文章

华为C语言编程规范

DKBA华为技术有限公司内部技术规范DKBA 2826-2011.5C语言编程规范2011年5月9日发布 2011年5月9日实施华为技术有限公司Huawei Technologies Co., Ltd.版权所有 侵权必究All rights reserved密级:confidentiality levelDKBA 2826-2011.52011-06-02 华为机密,未经许可不得扩散 Huawei Confidential 第2页,共61页Page 2 , Total61修订声明Revision

代码生成工具介绍和使用

代码生成工具介绍和使用 RUF MVC5 Repositories Framework Generator代码生成工具介绍和使用 功能介绍 这个项目经过了大半年的持续更新到目前的阶段基本稳定 所有源代码都是开源的,在github https://github.com/neozhu/MVC5-Scaffolder 共享 整个项目结构,技术框架完全是基于http://genericunitofworkandrepositories.codeplex.com/ 实现. 轻量级的N层架构,Unit Of

微软编程规范(文档)

项目编程规范 第一章 概述. 5 术语定义. 5 Pascal 大小写. 5 Camel 大小写. 5 文件命名组织. 5 1.3.1文件命名. 5 1.3.2文件注释. 5 第二章   代码外观. 7 2.1  列宽. 7 2.2  换行. 7 2.3  缩进. 7 2.4  空行. 7 2.5  空格. 8 2.6  括号 - () 8 2.7  花括号 - {} 9 第三章 程序注释. 10 3.1  注释概述. 10 3.2  文档型注释. 10 3.3  单行注释. 11 3.4  注

RUF MVC5 Repositories Framework Generator代码生成工具介绍和使用

RUF MVC5 Repositories Framework Generator代码生成工具介绍和使用 功能介绍 这个项目经过了大半年的持续更新到目前的阶段基本稳定 所有源代码都是开源的,在github https://github.com/neozhu/MVC5-Scaffolder 共享 整个项目结构,技术框架完全是基于http://genericunitofworkandrepositories.codeplex.com/ 实现. 轻量级的N层架构,Unit Of Work and Re

Android编程规范V1.0

转载请注明出处:http://blog.csdn.net/zhaokaiqiang1992 本文章是根据众多公司的编程规范整理而成,如果错误,还请指出. Android编程规范 编写人 赵凯强 日期 2014-8-5 审核人   日期   批准人   日期     修改记录(REVISION CHART) 版本 作者 修改描述 修改日期 1.0 赵凯强 初稿 2014-8-5     1.概述 1.1目的与概述 本文提供一整套编写高效可靠的android代码的标准.约定和指南.它们以安全可靠的软

C++的辅助工具介绍 [转]

C++的辅助工具介绍 1 文档类  (1) Doxygen  参考站点:http://www.doxygen.org  Doxygen是一种适合C风格语言(如C++.C.IDL.Java甚至包括C#和PHP)的.开放源码的.基于命令行的文档产生器.  (2) C++2HTML  参考站点:http://www.bedaux.net/cpp2html/  把C++代码变成语法高亮的HTML  (3) CodeColorizer  参考站点:http://www.chami.com/colorize

Linux下C++的编程——开偏介绍

C++是一个功能强大而又应用广泛的计算机语言,就应用领域而言,几乎无所不在,因为有操作系统的地方就会有C++的存在,热门程序而言,也就仅次于C和Java.而C与C++又有天然的血缘关系. 从事C++开发近两年,虽然开发的产品都是跨平台的,但个人直接接触到的编程工程还是更偏重于Windows平台(至少开发环境更多的是在Windows平台,还写过"带你玩转Visual Studio"系列的博文),而现在要自己独立地带领一个项目的开发,还是一个跨平台的项目,也就有必要到Linux下C++的编

最佳11个PHP编程规范

个人原创网址:http://www.phpthinking.com/archives/375 从设计之初,PHP被广泛用于开发基于Web的应用程序. 由于PHP是一种脚本语言,开发的时候必须遵守一些规范. 本文将讨论常用的良好的代码习惯,或者称为代码规范,在PHP领域. 1,错误报告开启 错误报告是在PHP中一个非常有用的功能,应同时在开发阶段启用. 这可以帮助我们确定我们的代码中的问题. 最常用的功能是"E_ALL",这有助于我们发现所有的警告和严重错误. 必须指出的是,我们把我们的

[HTML5]工具介绍

1. WebJavascript代码验证在线工具-JSLint   ">http://www.jslint.com/  JSLint是一个JavaScript验证工具(非开源),可以扫描JavaScript源代码来查找问题.如果JSLint发现一 个问题,JSLint就会显示描述这个问题的消息,并指出错误在源代码中的大致位置.有些编码风格约定可能导致未预见的行为或错误,JSLint除了能指 出这些不合理的约定,还能标志出结构方面的问题.尽管JSLint不能保证逻辑一定正确,但确实有助于发现