编码规范
（C#）
            sortedlist

目  录
1    项目风格    1
1.1    项目取名    1
1.2    项目目录设置    1
1.3    项目修改记录追踪    2
2    代码排版    2
2.1    引用    2
2.2    代码行、格式与修饰符    3
2.3    长行拆分    4
2.4    This 关键字    4
3    注释规范    4
3.1    文件的版权与版本的声明    4
3.2    函数、属性、类等注释    5
3.3    逻辑点注释    5
4    命名规范    5
4.1    Pascal、Camel及自定义命名约定    5
4.2    命名空间    6
4.3    类    6
4.4    接口    6
4.5    属性    7
4.6    字段    7
4.7    事件    7
4.8    方法    9
4.9    参数    9
4.10    常量    9
5    集合与泛型    9
6    用户提示    10
7    异常处理    10
8    程序效率    11
9    界面设计    12
9.1    设计原则    12
9.2    具体待定    12
10    附录:编程原则    12

1 项目风格
1.1 项目取名
    按照项目或者产品名称定义解决方案名称，如：“三维力控电网监测系统”，按照“功能名称”+“模块名称”命名工程，如：SYS.WcfService，按照“公司名称”+“产品名称”+“功能名称”+“模块名称” 定义命名空间，如： Sunwayland.DWJC.SYS.WcfService
1.2 项目目录设置
每个项目要考虑到代码重用性、可维护性以及扩展性，按照业务解耦、架构分层的要求设置项目目录，如：
并且解决方案目录要与项目目录一致，如：
1.3 项目修改记录追踪
每一个项目建立“变更.txt”文件记录重大变更，其格式如下：
日期：
修改人：
修改主题：
相关修改文件：
修改内容详细描述：
2 前端代码规范
2.1 HTML标记语言编码规范 
2.1.1 标记的换行规范：
  * 一个标记必须占用一行。不得出现两个标记在同一行的情况(同一标记的关闭标记除外)，如：
  <tr><td>text</td></tr>
  而必须写成：
  <tr>
      <td>text</td>
  </tr>
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>
2.1.3 标记的属性赋值规范
对于接受属性的标记，属性值必须使用双引号或者单引号包围。如:
    　<body bgcolor=”red”>
    　<font size=’7’>
    注意：必须确保属性的赋值无警告或错误。
2.1.4 标记的缩进规范
  * 最高一级的父标记采用左对齐顶格方式书写。
  * 下一级标记采用左对齐向右缩进一个Tab的方式书写
    　在下一级依此类推，分别左对齐相对于父标记向右缩进一个Tab的方式书写
  * 同一级标记的首字符上下必须对齐。
    注意：在进行代码缩进时，可使用VS2005及其以上版本的开发环境中的自动缩进功能。
2.2 客户端JavaScript规范
2.2.1 变量命名规范
  * 常量以及全局变量名必须全部使用大写字母
  * 变量名首字母必须小写
  * 变量名必须使用其类型的所写字符串开始。各种类型的所写字符串如下：
  * 整型变量：int
  * 长整型变量：lng
  * 浮点型变量：flt
  * 双精度变量：dbl
  * 对象引用变量：obj
  * 字符串变量:str
  * Date类型变量：dtm
  * 变量名必须采用有意义的单词命名，如：
strUserName、lngArrayIndex
  * 变量名除首字母小写外，其他单词首字符必须大写
  * 如果变量名过长可以使用单词缩写，除了被广泛了解的单词缩写以外，所有使用单词所写的变量名必须在定义时给出注释,如：
  var strAdName //用于表示Administrator帐户的名称
  var strAdminName //不用给出注释，Admin被广泛了解
2.2.2 变量使用规范
  * 变量使用前必须定义。没有定义的变量禁止使用
  * 变量的使用尽量缩小到小的作用域。如循环使用
  for(var I=0;I<12;I++){
   
  }
  而不是：
  var I;
  for(I=0;I<12,I++){
   
  }
2.2.3 对象命名规范
  各种页面对象如text输入框、按钮、下拉选择框在命名时必须使用以下对应前缀：
  * text输入框:txt
  * button按钮：btn
  * select下拉选择框：sel
  * option项:opt
  * form表单：frm
  * frame框架：fra
  * hidden表单项：hdn
  * div标记：div
  * span标记:spn
  * 对话框对象:dlg
  * 窗口对象：wnd
2.2.4 函数以及子过程命名规范
  * 函数命名必须使用动词＋名词对的方式，并且能够体现函数的功能
  * 函数命名的动词前缀必须是同函数功能相关的完整动词
  * 函数命名第一个单词的首字母小写，后面每一个单词的首字母大写
    如：GetUserName，CreateNewUser，UpdateUserInfos
2.3 文件夹及文件命名规范
文件夹命名一般采用英文，长度一般不超过20个字符，命名采用小写字母。除特殊情况才使用中文拼音，一些常见的文件夹命名如：images(存放图形文件)，flash（存放Flas件），style(存放CSS文件)，scripts（存放Javascript脚本），inc(存放include文件)，link（存放友情链接）,media(存放多媒体文件)等。

版权声明：本站内容均来自互联网，仅供演示用，请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198，我们将在24小时内删除。