C# 编码规范模板.xlsVIP

C#注释规范Checklist

C#编码规范Checklist

C#编码规范Checklist

文件编码：

项目名称：

检查日期：

项目编号：

检查人：

项目负责人：

确认人：

检查大项

检查子项

完成情况

备注

规范性

编码是否符合了公司发布的C#编码规范

命名约定

方法名、类名、文件名、命名空间名、项目名、程序集名是否采用Pascal大小写形式

变量名、参数名是否采用Camel大小写形式

是否采用了不推荐使用的匈牙利命名法

变量命名是否有意义（循环变量除外）

类名的规范性：

1、接口类是否以I为前缀

2、属性类是否以Attribute为后缀

3、事件消息类是否以EventArgs为后缀

4、异常类是否以Exception为后缀

编码风格

是否采用VS提供的缩进风格

是否使用Tab做手工缩进

左右大括号是否单独占一行

运算符和括号前后是否空一格

类、方法等之间是否以空行相隔

类长度是否超过2000行

方法长度是否超过200行

功能实现

是否一个方法只完成一个任务

是否避免在方法间共享成员变量

是否单个文件中写了多个类

是否使用常量表示程序中用到的固定数值

是否使用资源文件存储程序中用到的字符串常数

用户界面是否出现错别字

try-catch代码块是否太大

是否捕获了异常但却什么都没做

本次检查小计：

合格√

合格项数量：

一般符合

一般符合项数量：

不符合

不符合项数量：

不适用

不适用项数量：

C#注释规范Checklist

注释是否符合了公司发布的C#注释规范

是否使用“///”方式添加注释

方法注释是否明确该方法功能、各参数含义以及返回值等信息

复杂算法或引用的科学原理是否进行了说明

注释中是否出现错别字

注释是否通顺易懂，是否存在歧义

注释内容是否包含无意义的装饰符号或语句