donet编程资料资源-CSDN文库

需积分: 9 35 浏览量 2012-09-01 12:17:15 上传评论收藏 184KB DOC 举报

ASP.NET编码分为两大部分，一部分为客户端的静态文件编码，另一部分为包含服务器端脚本的动态文件编码。静态文件编码分Script编码和HTML编码两部分。服务器端编码则分为服务器脚本、客户端脚本、HTML脚本三部分。编码规范采用如下约定： 1. 所有客户端脚本一律使用JavaScript 2. 所有服务器端脚本一律使用C# 3. 静态页面输出一律使用HTML脚本 4. 本规范不适用于由服务器端脚本所产生的客户端脚本代码。 ### ASP.NET 编码规范详解 #### 第一章：编码规范概述 ASP.NET 的编码主要分为两大块：客户端静态文件编码与服务器端动态文件编码。客户端静态文件编码涉及Script（通常指的是JavaScript）与HTML标记语言；服务器端动态文件编码则包括了服务器端脚本（一般使用C#）、客户端脚本（此处特指由服务器端动态生成的脚本）以及HTML脚本。为了保证代码的一致性与可维护性，本文档将详细阐述这些不同部分的编码规范。 **重要约定：** - **客户端脚本**一律使用JavaScript。 - **服务器端脚本**一律使用C#。 - **静态页面输出**一律使用HTML脚本。 - **例外情况**：本规范不适用于由服务器端脚本所产生的客户端脚本代码。 #### 第二章：静态文件编码规范 ##### HTML标记语言编码规范 - **换行规范**：每个HTML标记必须独占一行，不允许两个标记出现在同一行（除了同一标记的闭合标记）。 - 示例：`<tr><td>text</td></tr>` 应改为 `<tr>\n<td>text</td>\n</tr>` - **关闭规范**：所有需要关闭的HTML标记，例如 `<html>`、`<title>`、`<body>` 等，必须与其对应的闭合标记同时出现。 - 示例：`<body>...............</body>` - **属性赋值规范**：接受属性的HTML标记，其属性值必须使用双引号（`"`）或单引号（`'`）包围。 - 示例：`<body bgcolor="red">` 或 `` - **缩进规范**：最高级别的父标记采用左对齐顶格方式书写，下一级标记则向右缩进一个Tab键的距离，以此类推。 - 示例： ```html <html> <body> Text here. </body> </html> ``` ##### 客户端JavaScript规范 - **变量命名规范**：常量以及全局变量名必须全部使用大写字母，变量名首字母必须小写，并且必须使用类型所写字符串开始。 - 示例：整型变量 `int`，字符串变量 `str`。 - 变量示例：`strUserName`、`intUserAge`。 - **变量使用规范**：避免在函数外部定义变量，尽可能限制变量的作用域。 - 示例：使用局部变量而非全局变量。 - **对象命名规范**：对象引用变量使用前缀 `obj`。 - 示例：`objMyObject`。 - **函数命名规范**：函数命名应直观反映其功能，采用PascalCase（Pascal命名法）。 - 示例：`showAlert()`、`getUserInfo()`。 #### 第三章：动态文件编码规范动态文件编码规范主要涉及C#的编码规则，包括命名规范、注释规范、缩进规范等。 - **命名规范**：类、变量、函数和控件的命名遵循一定的规则。 - 类命名：使用PascalCase，反映类的功能。 - 示例：`UserInfoManager` - 变量命名：首字母小写，后续单词首字母大写。 - 示例：`int userAge` - 函数命名：使用PascalCase，描述函数的功能。 - 示例：`getUserName()` - 控件命名：根据控件类型命名。 - 示例：`txtUsername` - **注释规范**：提供清晰的注释，帮助理解代码逻辑。 - 文件头部注释：简述文件用途、作者等。 - 函数、属性、类注释：描述功能和参数。 - 程序流程注释：关键逻辑点添加注释。 - **缩进规范**：保持代码结构清晰。 - 示例：使用4个空格作为缩进单位。 - **异常处理规范**：使用try-catch块处理可能发生的异常。 - 示例：捕获并记录异常。 - **Request、Session、Application使用规范**：合理使用这些内置对象来存储和检索信息。 #### 第四章：文件命名规范 - **数据库命名规范**：规定了数据文件、表、字段、视图、存储过程的命名规则。 - 数据文件命名：反映文件存储的数据类型。 - 示例：`UsersData.mdf` - 表命名：反映表的主要用途。 - 示例：`tblUsers` - 字段命名：直观描述字段含义。 - 示例：`fldUserID` - 视图命名：描述视图提供的数据视图。 - 示例：`vwUsersSummary` - 存储过程命名：描述存储过程的功能。 - 示例：`spGetUserById` - SQL语句编写：使用有意义的别名，提高SQL查询的可读性。 - **文件夹及文件命名规范**：规定了图片、动态文件等的命名原则。 - 图片命名：反映图片内容。 - 示例：`logo.png` - 动态文件命名：根据文件功能命名。 - 示例：`UserLogin.cs` #### 第五章：良好的编程习惯 - **避免使用大文件**：控制单个文件大小，便于管理。 - **避免写太长的方法**：每个方法实现单一功能。 - **方法命名需能看出它做什么**：直观地反映方法的功能。 - **一个方法只完成一个任务**：增强代码的可读性和可维护性。 - **使用C#的特有类型**：利用C#的特性，提高代码质量。 - **别在程序中使用固定数值**：使用常量或配置文件代替硬编码数值。 - **别用字符串常数**：使用枚举或常量代替硬编码字符串。 - **必要时使用enum**：定义一组固定的选项。 - **别把成员变量声明为public或protected**：使用private修饰符保护内部状态。 - **不在代码中使用具体的路径和驱动器名**：使用配置文件或环境变量指定路径。 - **人性化消息提示**：在用户界面中提供友好且有意义的消息提示。 - **多使用StringBuilder替代String**：在频繁修改字符串时提高性能。通过上述规范，可以有效地提高ASP.NET应用程序的质量，确保代码的一致性、可读性和可维护性。

资源推荐

资源详情

资源评论

ASP.NET 编码规范............................................................................................................................2
第一章 编码规范概述................................................................................................................2
第二章 静态文件编码规范........................................................................................................2
1. HTML 标记语言编码规范............................................................................................3
1.1 标记的换行规范：...............................................................................................3
1.2 标记的关闭规范...................................................................................................3
1.3 标记的属性赋值规范...........................................................................................3
1.4 标记的缩进规范...................................................................................................3
2. 客户端 JavaScript 规范..................................................................................................4
2.1 变量命名规范.......................................................................................................4
2.2 变量使用规范.......................................................................................................4
2.3 对象命名规范.......................................................................................................5
2.4 函数以及子过程命名规范...................................................................................5
第三章 动态文件编码规范........................................................................................................5
1、命名规范.......................................................................................................................5
1.1、类的命名规范....................................................................................................5
1.2、变量命名规范....................................................................................................6
1.3、函数命名及使用规范........................................................................................6
1.4、控件命名规范....................................................................................................7
2、注释规范.......................................................................................................................8
2.1、文件头部注释....................................................................................................8
2.2、函数、属性、类等注释....................................................................................8
2.3、程序流程及逻辑点注释....................................................................................9
3、缩进规范.......................................................................................................................9
4、异常处理规范...............................................................................................................9
5、Request、Session、Application 使用规范................................................................10
第四章 文件命名规范..............................................................................................................11
1．数据库命名规范.........................................................................................................11
1.1、数据文件命名规范..........................................................................................11
1.2、数据库表命名规范..........................................................................................11
1.3、数据库字段命名规范......................................................................................11
1.4、数据库视图命名规范......................................................................................12
1.5、存储过程命名规范..........................................................................................12
1.6、SQL 语句编写规范.........................................................................................12
2.文件夹及文件命名规范................................................................................................12
2.1 图片的命名原则.................................................................................................12
2.2 动态语言文件命名规则.....................................................................................13
第五章 良好的编程习惯..........................................................................................................14
1、避免使用大文件.........................................................................................................14
2、避免写太长的方法.....................................................................................................14
3、方法名需能看出它作什么.........................................................................................14
4、一个方法只完成一个任务.........................................................................................14
5、使用 C# 或 VB.NET 的特有类型..............................................................................14
6、别在程序中使用固定数值.........................................................................................15