ASPNET编码规范

来源：互联网发布：软件项目建设方案模板编辑：程序博客网时间：2024/05/14 02:47

ASP.NET编码规范(部分针对MVC框架)：
ASP.NET包括客户端的静态文件编码和包含服务器端的动态文件编码。
静态文件编码分Script编码和HTML编码。
服务器端编码：服务器脚本、客户端脚本、HTML脚本。
编码规范采用如下约定：
1.所有客户端脚本一律使用JavaScript
2.所有服务器端脚本一律使用C#
3.静态页面输出一律使用HTML脚本
4.本规范不适用于由服务器端脚本所产生的客户端脚本代码。
一：静态文件编码规范：
1.标记的换行规范:一个标记必须占用一行。
2.标记的关闭规范:静态文件内容必须包含在<body></body>标记中间;
<body>标记必须包含在<html></html>标记中间;
对于需要关闭的标记不得出现交叉包含的语句。
3.标记的属性赋值规范:对于接受属性的标记,属性值必须使用双引号或者单引号包围。<body bgcolor="red">
4.标记的缩进规范:Ctrl+K+D
二：客户端JavaScript规范
1.变量命名规范:常量以及全局变量名必须全部使用大写字母。
变量名必须使用其类型的所写字符串开始,如下：
* 整型变量：int
* 长整型变量：lng
* 浮点型变量：flt
* 双精度变量：dbl
* 对象引用变量：obj
* 字符串变量:str
* Date类型变量：dtm
* 变量名必须采用有意义的单词命名
* 变量名除首字母小写外，其他单词首字符必须大写
2.变量使用规范：
* 变量使用前必须定义。
* 变量的使用尽量缩小到小的作用域。如for
3.对象命名规范: * text输入框:txt
* button按钮：btn
* select下拉选择框：sel
* option项:opt
* form表单：frm
* frame框架：fra
* hidden表单项：hdn
* div标记：div
* span标记:spn
* 对话框对象:dlg
* 窗口对象：wnd
4.函数以及子过程命名规范:
* 函数命名必须使用动词＋名词对的方式，并且能够体现函数的功能
* 函数命名的动词前缀必须是同函数功能相关的完整动词
* 函数命名第一个单词的首字母小写，后面每一个单词的首字母大写
三：动态文件编码规范：
1.类的命名规范：
* 以Class声明的类，都必须以名词或名词短语命名，体现类的作用。
* 当类只需有一个对象实例（全局对象，比如Application等），必须以Class结尾
* 当类只用于作为其他类的基类，根据情况，以Base结尾。
2.控件命名规范：
*Label lbl
*TextBox txt
*Button btn
*CheckBox chk
*RadioButton rdo
*CheckBoxList chklst
*RadioButtonList rdolst
*ListBox lst
*DropDownList ddl
*DataGrid dg
*DataList dl
*Image img
*Table tbl
*Panel pnl
*LinkButton lnkbtn
*ImageButton imgbtn
*Calender cld
*AdRotator ar
*RequiredFieldValidator rfv
*CompareValidator cv
*RangeValidator rv
*RegularExpressionValidator rev
*ValidatorSummary vs
*CrystalReportViewer rptvew
四：良好的编程习惯：
1.避免使用大文件：
一个文件代码不要超过300~400行
2.避免些太长的方法：
典型的方法代码在1~25行之间
3.方法名需看出它在做什么...
4.一个方法完成一个任务：
不要把多个任务组合到一个方法中,即使任务非常小...
5.使用C#特有类型： int age；而不是 Int16 age;
6.别再程序中使用固定数值：
用const代替。
7.别用字符串常数；用资源文件。
8.必要时使用enum：if->case->enum
9.别把成员变量声明为public或Protected，成员变量前缀为'_'
10.不要在代码中使用具体的路径和驱动器名：相对路径
11.人性化消息提示
12.多使用StringBuilder代替String
*String对象是不可改变的。每次使用System.String类中的方法之一时，都要在内存中创建一个新的字符串对象，这就需要为该新对象分配新的空间。在需要对字符串执行重复修改的情况下，与创建新的String对象相关的系统开销可能会非常昂贵。如果要修改字符串而不创建新的对象，则可以使用System.Text.StringBuilder类。例如，当在一个循环中将许多字符串连接在一起时，使用StringBuilder类可以提升性能。
以下方法常用于修改StringBuilder的内容。
*StringBuilder.Append 将信息追加到当前StringBuilder的结尾。
*StringBuilder.AppendFormat 用带格式文本替换字符串中传递的格式说明符。
*StringBuilder.Insert 将字符串或对象插入到当前StringBuilder对象的指定索引处。
*StringBuilder.Remove 从当前StringBuilder对象中移除指定数量的字符。
*StringBuilder.Replace 替换指定索引处的指定字符。

转载来源：http://blog.csdn.net/allcanresolved/article/details/8290488

0 0