1.1 编码规范(系统开发架构与设计步步谈)

系统开发管理、架构与设计步步谈随笔索引

前言导读

网站框架系列目录

1.1编码规范

1.2 User Interface 规范

1.3 菜单管理

1.4 数据验证

1.5 异常处理机制

1.6 安全管理

1.7 系统日志管理

    邮件和手机短信通知服务

1.8 预防SQL注入

1.9 Javascript统一管理

1.10 查询缓存

1.11 并发处理

1.12 文件存储管理

1.13 供其它程序调用的WCF接口

1.14 调用其它应用程序接口的公共处理

1.15 数据库索引应用

1.16 数据库备份和恢复

1.17 数据库复制

1.18 SQL SERVER 性能分析与处理

1.19 安装与布署

项目管理与设计（待续……）

 

正文

 

1.1   编码规范

现在做一个项目都已经不是一个人单打独斗，靠一个项目组一起合作才能把事情做完，几个人一起做一件事情，都需要规范来约束大家，其中代码的命名也需要有要求，要定一个要求，大家都需要遵守，让整个项目的代码看起来都是出自一人之手。这样做的好处不只是代码的好看，更重要的是看别人的代码更容易理解。

编码规范主来自自于控件命名规范、类命名、方法命名、数据库表命名、视图命名、存储过程命名、索引命名

以下是我平常遇到的一些情况，命名并无严格要求一定要什么样子，根据实际情况，只要大家遵寻一个标准即可。

1.1.1控件命名

    

控件名	命名	备注
Label	Lb_字段名
Button	btn_功能名
Date Control	date_功能名
CheckBox	cb_字段名
CheckBoxList	Cbl_字段名
DropDownList	ddl_数据源名
FileUpload	fu_功能名
HiddenField	hf_字段名
HyperLink	hy_目标url 名
Image	img_图片名
ImageButton	Imgbtn_功能名
LinkButton	linkbtn_功能名
ListBox	lisBox_数据源名
Panel	pl_功能名
RadioButton	radbtn_功能名
RadioButtonList	rbl_数据源名
Table	table_功能名
TextBox	txt_字段名
DataList	dataList_数据源名
DetailView	dv_数据源名
EntityDataSource	eds_数据源名
FormView	fv_数据源名
GridView	gv_数据源名
LinqDataSource	linqds_数据源名
ListView	listV_数据源名
ObjectDataSource	ods_数据源名
SqlDataSource	sqlds_数据源名
XMLDataSource	xmlds_数据源名
CompareValidator	comvalidator_控件名
CustomValidator	cusvalidator_控件名
RegularExpressionValidator	rev_控件名
RequiredFieldValidator	rfv_控件名
ValidationSummary	validationsum_功能名
Menu	menu_数据源名
SiteMapPath	smp_数据源名
TreeView	tv_数据源名
ReportViewer	report_数据源名
Div	div_功能名

   

 

 

   

 

1.1.2 类、变量规范

     命名 ： 用功能命名，每个英文单词首字母大写，如

             Public Class QueryProduct

              {}

                    接口要用用I 开头,如

                    Public Calss IQueryProduct

                    {}

       1.1.3 类方法规范

           命名以功能命名，且每个英文单词首字母大写,每个方法需要完整的注释,如

       

/// <summary>

        /// 号码信息查询

        /// </summary>

        /// <param name="mobileNo">手机号码</param>

        /// <returns>江苏苏州|移动全球通卡</returns>

        public string GetMobileInfo(string mobileNo)

        {

            return Channel.GetMobileInfo(mobileNo);

        }   

       1.1.4 数据库规范

       

对像名	命名	备注
Field	同类命名同
Table	T_功能名
View	V_功能名
StoreProcedure	SP_功能名
Index	I_功能名

 

           

       综述 ： 以上只是一些平时经常看到的一些情况，实际开发过程中肯定会遇到以外的情况，需要及时发现，及时补充，并能有很好的代码检查过程，而不能一味为了项目进度而忽视了一些项目开发过程的不为客户所看见的内容。