Asp.Net编码规范

最新推荐文章于 2020-01-05 21:32:40 发布

风之_诉

最新推荐文章于 2020-01-05 21:32:40 发布

阅读量2.1k

点赞数 1

分类专栏： ASP.NET 文章标签： asp.net 编码规范

本文链接：https://blog.csdn.net/luming666/article/details/53187406

版权

本文详细介绍了ASP.NET的编码规范，包括静态文件编码、服务器端脚本编码、HTML标记规范、JavaScript规范、函数命名、控件命名、注释规则、命名空间、方法命名等，旨在提升代码可读性、一致性，适用于.NET平台的软件开发。规范涵盖变量命名、对象引用、错误处理、代码结构等多个方面，旨在提高代码质量和维护性。

摘要由CSDN通过智能技术生成

代码编写规范如下：　（c#.net与asp.net）
1 目的
一.为了统一公司软件开发设计过程的编程规范
二.使网站开发人员能很方便的理解每个目录,变量，控件，类，方法的意义
三.为了保证编写出的程序都符合相同的规范，保证一致性、统一性而建立的程序编码规范。
四.编码规范和约定必须能明显改善代码可读性，并有助于代码管理、分类范围适用于企业所有基于.NET平台的软件开发工作

2 范围
本规范适用于开发组全体人员，作用于软件项目开发的代码编写阶段和后期维护阶段。

1.1ASP.Net编码规范通述

ASP.Net编码分为两大部分，一部分为静态文件编码，一部分为包含服务器端脚本的动态文件编码。静态文件编码分Script编码和HTML编码两部分。
服务器端编码则分为服务器脚本、客户端脚本、HTML脚本三部分。
编码规范采用如下约定：
所有客户端脚本一律使用JavaScript
所有服务器端脚本一律使用C#
静态页面输出一律使用HTML脚本
本规范不适用于由服务器端脚本所产生的客户端脚本代码。

1.2静态文件编码规范
静态文件脚本部分采用JavaScript编写。输出部分采用HTML标记语言。
1.2.1HTML标记语言编码规范1.2.1.1标记的换行规范
* 一个标记必须占用一行。不得出现两个标记在同一行的情况(同一标记的关闭标记除外)，如：
<tr><td>text</td></tr>
而必须写成：
<tr>
<td>text</td>
<tr>
1.2.1.2标记的关闭规范
* 静态文件内容必须包含在<body></body>标记中间
* <body>标记必须包含在<html></html>标记中间
* 对于需要关闭的标记，如：
<html><title><body><table><tr><td><p><textarea><select><font><option><div><span>
必须同其关闭标记同时出现。如
<body>…<p>…<font>….</font>….</p>…..</body>
* 不得出现交叉包含的语句，如：
<p><font>…..</p></font>
1.2.1.3标记的属性赋值规范
对于接受属性的标记，属性值必须使用双引号或者单引号包围。如:
<body bgcolor=”red”>
<font size=’7’>

注：在页面上如果是HTML标签，尽量只能出现id，class属性。属性越少越好。

1.2.1.4标记的缩进规范
* 最高一级的父标记采用左对齐顶格方式书写。
* 下一级标记采用左对齐向右缩进一个Tab的方式书写
在下一级依此类推，分别左对齐相对于父标记向右缩进一个Tab的方式书写
* 同一级标记的首字符上下必须对齐。
1.2.2客户端JavaScript规范1.2.2.1变量命名规范
* 常量以及全局变量名必须全部使用大写字母
* 变量名首字母必须小写。
* 变量名必须使用其类型的所写字符串开始。各种类型的所写字符串如下：
* 整型变量：int
* 长整型变量：lng
* 浮点型变量：flt
* 双精度变量：dbl
* 对象引用变量：obj
* 字符串变量:str
* Date类型变量：dtm
* 变量名必须采用有意义的单词命名，如：
strUserName、lngArrayIndex
* 变量名除首字母小写外，其他单词首字符必须大写
* 如果变量名过长可以使用单词缩写，除了被广泛了解的单词缩写以外，所有使用单词所写的变量名必须在定义时给出注释,如：
var strAdName //用于表示Administrator帐户的名称
var strAdminName //不用给出注释，Admin被广泛了解
1.2.2.2变量使用规范
* 变量使用前必须定义。没有定义的变量禁止使用
* 变量的使用尽量缩小到小的作用域。如循环使用
for(var I=0;I<12;I++){

}
而不是：
var I;
for(I=0;I<12,I++){

}
1.2.2.3对象命名规范
各种页面对象如text输入框、按钮、下拉选择框在命名时必须使用以下对应前缀：
* text输入框：txt
* button按钮：btn
* select下拉选择框：sel
* option项：opt
* form表单：frm
* frame框架：fra
* hidden表单项：hdn
* div标记：div
* span标记：span
* 对话框对象：dlg
* 窗口对象：win
1.2.3函数以及子过程命名规范
* 函数命名必须使用动词＋名词对的方式，并且能够体现函数的功能
* 函数命名的动词前缀必须是同函数功能相关的完整动词
* 函数命名第一个单词的首字母小写，后面每一个单词的首字母大写

1.3动态文件编码规范1.3.1HTML书写规范命名（控件）
* TextBox输入框:txt
* Button按钮：btn
* DropDownList下拉选择框：ddl
* Label文本:lbl
* CheckBox复选框：cbx
* RadioButton单选按钮：rbtn
* hidden表单项：hdn

注：HTML书写规范必须符合静态文件HTML标记书写规范，服务器控件命名一般以控件单纯的首字母的简写形式作为前缀。

1.3.2客户端脚本规范
书写规范必须符合静态文件HTML标记书写规范，服务器控件命名一般以控件单纯的首字母的简写形式作为前缀。

1.3.2客户端脚本规范
动态文件客户端脚本一律采用JavaScript书写，并必须符合静态文件编码规范中有关JavaScript编码规范的规定。

1.3.3服务器端脚本书写规范
3 注释规范
3.1 概述
a) 注释要求英文及英文的标点符号。
b) 注释中，应标明对象的完整的名称及其用途，但应避免对代码过于详细的描述。
c) 每行注释的最大长度为100个字符。
d) 将注释与注释分隔符用一个空格分开。
e) 不允许给注释加外框。
f) 编码的同时书写注释。
g) 重要变量必须有注释。
h) 变量注释和变量在同一行，所有注释必须对齐，与变量分开至少四个“空格”键。
如：int m_iLevel,m_iCount; // m_iLevel ....tree level
// m_iCount ....count of tree items