程序设计、编码规范

程序设计、编码规范第1页共16页程序设计、编码规范程序设计、编码规范第2页共16页目录1.程序界面设计....................................................................................................................31.1.Web网站结构规范.............................................................................................................31.2.客户端文件命名规范........................................................................................................31.2.1.Web页面命名规范.....................................................................................................31.2.2.WindowsForm页面命名规范...................................................................................41.3.界面中控件命名规范........................................................................................................41.3.1.Button控件命名规范...............................................................................................41.3.2.输入、选择控件命名规范........................................................................................61.3.3.DataGrid网格控件命名规范...................................................................................61.3.4.工具条控件命名规范................................................................................................71.4.菜单及菜单项命名规范....................................................................................................72.程序编码规范....................................................................................................................92.1.代码格式...........................................................................................................................92.2.接口、类、方法、属性命名规范..................................................................................102.2.1.接口及接口成员的命名规范..................................................................................102.2.2.类的命名规范..........................................................................................................102.2.3.类方法命名规范......................................................................................................112.2.4.类属性的命名规范..................................................................................................112.3.注释规范.........................................................................................................................112.3.1.整体注释规范：......................................................................................................122.3.2.模块注释规范..........................................................................................................122.3.3.类属性注释规范......................................................................................................132.3.4.方法注释规范..........................................................................................................142.3.5.代码间注释规范......................................................................................................142.4.变量命名规范..................................................................................................................143.项目特定规范..................................................................................................................15程序设计、编码规范第3页共16页1.程序界面设计1.1.Web网站结构规范为了保证系统有一个统一的界面风格及布局风格，需在网站虚拟根目录下增下一个存放系统图片文件的Image目录和一个存放系统CSS的Css目录。程序中所用到的所有系统图片及CSS都将从此两个目录中进行引出。两个目录中都存放有不同风格的图片，用户可以设置系统使用的风格。系统中使用的CSS的文件名统一命名为：OceanSoft.css1.2.客户端文件命名规范系统中一般的单据的命名都必须按下面的规范命名：1.2.1.Web页面命名规范新增单据的aspx页面的名称=代表此单据功能的英文单词+Add.aspx，并尽量与页面对应的数据库表名相对应。例如：职员新增的aspx页面的名称为：EmployeeAdd.aspx查询单据的aspx页面的名称=代表此单据功能的英文单词+Qry.aspx例如：职员查询的aspx页面的名称为：EmployeeQry.aspx查询结果显示的aspx页面的名称=代表此单据功能的英文单词+Dts.aspx例如：职员查询结果显示的aspx页面的名称为：EmployeeDts.aspx程序设计、编码规范第4页共16页单据主操作页面的名称=代表此单据功能的英文单词+Manage.aspx，并尽量与页面对应的数据库表名相对应。例如：职员信息维护的主操作aspx页面名称为：EmployeeManage.cs其它界面的aspx页面名称=代表此单据功能的英文单词+.aspx其它界面主要是指一些业务单据以外的界面。如参数设置等界面。如SysInforSetting.aspx1.2.2.WindowsForm页面命名规范新增单据的cs页面的名称=frm+代表此单据功能的英文单词+Add.cs，并尽量与页面对应的数据库表名相对应。例如：职员新增的cs页面的名称为：frmEmployeeAdd.aspx查询单据的aspx页面的名称=frm+代表此单据功能的英文单词+Qry.cs例如：职员查询的cs页面的名称为：frmEmployeeQry.aspx查询结果显示的cs页面的名称=frm+代表此单据功能的英文单词+Dts.cs例如：职员查询结果显示的cs页面的名称为：frmEmployeeDts.cs单据主操作页面的名称=frm+代表此单据功能的英文单词+Manage.cs，并尽量与页面对应的数据库表名相对应。例如：职员信息维护的主操作cs页面名称为：frmEmployeeManage.cs其它界面的cs页面名称=frm+代表此单据功能的英文单词+.cs其它界面主要是指一些业务单据以外的界面。如参数设置等界面。1.3.界面中控件命名规范1.3.1.Button控件命名规范按钮类别按钮功能名称ID可用状态图片名称不可用状态图片名称标题TextCssClass排列序号登录(Login)登录按钮cmdLogincmdLogin.GIFCmdLogin_False.GIF登录1登录取消按钮cmdLoginCancelcmdLoginCancel.GIF取消2单据新增界面(New)关闭按钮cmdNewClosecmdNewClose.GIFcmdNewClose_False..GIF关闭Button1新增按钮cmdNewAddcmdNewAdd.GIFcmdNewAdd_False..GIF新增Button2保存按钮cmdNewSavecmdNewSave.GIFcmdNewSave_False..GIF保存Button3删除按钮cmdNewDeletecmdNewDelete.GIFcmdNewDelete_False..GIF删除Button4复制按钮cmdNewCopycmdNewCopy.GIFcmdNewCopy_False..GIF复制Button5查询按钮cmdNewSearchcmdNewSearch.GIFcmdNewSearch_False..GIF查询Button6设置按钮cmdNewSettingcmdNewSetting.GIFcmdNewSetting_False..GIF设置…Button7打印按钮cmdNewPrintcmdNewPrint.GIFcmdNewPrint.GIF打印Button8程序设计、编码规范第5页共16页帮助按钮cmdNewHelpcmdNewHelpcmdNewHelp_False.GIF帮助Button9单据主界面(Main)新增按钮cmdMainAddcmdMainAdd.GIFcmdMainAdd_False..GIF新增Bu