C# asp.net编码规范文档

目录

目录.....................................................................................................................................................1

1． 编写目的......................................................................................................................................2

2． 程序命名规范..............................................................................................................................2

基本约定.....................................................................................................................................2

控件命名规范.............................................................................................................................4

ADO.NET 控件命名规范..........................................................................................................6

方法定义.....................................................................................................................................8

虚方法定义.................................................................................................................................9

类的成员定义.............................................................................................................................9

结构定义.....................................................................................................................................9

结构成员定义.............................................................................................................................9

接口定义.....................................................................................................................................9

接口的方法和成员定义...........................................................................................................10

自定义异常定义.......................................................................................................................10

注释规范...................................................................................................................................10

第 1 页 总计 23 页

为了使团队中的每一位成员都形成统一的开发约定，特制定本规范文档，在今后的开

发过程中，请严格按照此文档约定的规则进行编码。通过此规范，希望可以给各程序员之

间起到沟通的桥梁的作用，并增强程序的可读性。

如在使用过程中，碰到本文档中没进行约定的规则，待商议后对该文档进行补充完善。

如:













 类文件名的名称必须要能反应类的内容，最好是和类同名，一个文件只写一个类，

第 2 页 总计 23 页



错误编写：



 switch 语句一定要有 default 来处理意外情况。

 同程序外部连接（如连接数据库、接口、文件等）一定要 捕获任何类型的异常

（try）给出友好的消息给用户，必要时用日志记录错误的细节，包括发生的时间 ，

和相关方法，类名等。

错误编写：

语句。

 把引用的系统的 namespace 和自定义或第三方的分开。

"#

"#$

"#$$"#

"#$$%

"#$$%$

&'"$"

(

 不在代码中使用具体的路径和驱动器名，必须使用相对路径。

 代码的缩进用 Tab，而不要用 space。

 使用某个控件的值时，尽量命名局部变量。

)

第 3 页 总计 23 页



"*$

"+*"

"

到不同类中。

第 4 页 总计 23 页

第 5 页 总计 23 页