文档介绍:程序设计、编码规范
目录
程序界面设计 3
1. 1. Web网站结构规范 3
客户端文件命名规范 3
1. Web页面命名规范 3
1. 2. 2. Windows Form 页面命名规范 4
1. 3, 界面中控件命名规范 4
1. 3. 1. Button控件命名规范 4
2, 输入、选择控件命名规范 6
3. 3. DataGrid网格控件命名规范 6
4. 工具条控件命名规范 7
菜单及菜单项命名规范 7
程序编码规范 9
1. 代码格式 9
2. 2. 接口、类、方法、属性命名规范 9
2. 2. 1. 接口及接口成员的命名规范 9
2. 2. 2. 类的命名规范 10
2. 2. 3, 类方法命名规范 11
2. 2. 4. 类属性的命名规范 11
2. 3, 注释规范 11
2. 3. 1. 整体注释规范: 11
2. 3. 2. 模块注释规范 12
2. 3. 3, 类属性注释规范 13
2. 3. 4. 方法注释规范 13
2. 3. 5, 代码间注释规范 14
2. 4. 变量命名规范 14
项目特定规范 15
程序界面设计
1. Web网站结构规范
为了保证系统有一个统一的界面风格及布局风格,需在网站虚拟根目录下增下-个存放系统图片文件的
Image目录和一个存放系统CSS的Css目录。
程序中所用到的所有系统图片及CSS都将从此两个目录中进行引出。两个目录中都存放有不同风格的图片, 用户可以设置系统使用的风格。
系统中使用的CSS的文件名统一命名为:
客户端文件命名规范
系统中一般的单据的命名都必须按下面的规范命名:
1. Web页面命名规范
/ 新增单据的aspx页面的名称=代表此单据功能的英文单词+,并尽量与页面对应 的数据库表名相对应。
例如:职员新增的aspx页面的名称为:
/ 查询单据的aspx页面的名称=代表此单据功能的英文单词+
例如:职员查询的aspx页面的名称为:
/ 查询结果显示的aspx页面的名称=代表此单据功能的英文单词+
例如:职员查询结果显示的aspx页面的名称为:
/ 单据主操作页面的名称=代表此单据功能的英文单词+ ,并尽量与页面对应的
数据库表名相对应。
例如:职员信息维护的主操作aspx页面名称为:
/ 其它界面的aspx页面名称=代表此单据功能的英文单词+.aspx
其它界面主要是指一些业务单据以外的界面。如参数设置等界面。
2. 2. Windows Form页面命名规范
/ 新增单据的CS页面的名称=frm+代表此单据功能的英文单词+,并尽量与页面对应 的数据库表名相对应。
例如:职员新增的cs页面的名称为:
/ 查询单据的aspx页面的名称=frm+代表此单据功能的英文单词+
例如:职员查询的cs页面的名称为:
/ 查询结果显示的cs页面的名称=frm+代表此单据功能的英文单词+
例如:职员查询结果显示的cs页面的名称为:
/ 单据主操作页面的名称=frm+代表此单据功能的英文单词+ ,并尽量与页面对应 的数据库表名相对应。
例如:职员信息维护的主操作cs页面名称为:
/ 其它界面的cs页面名称=frm+代表此单据功能的英文单词+.cs '
其它界面主要是指一些业务单据以外的界面。如参数设置等界面。
界面中控件命名规范
3. 1. Button控件命名规范
按钮类 别
按钮功能
名称ID
可用状态 图片名称
不可用状态 图片名称
标题
Text
CssClass
排列
序号
登录 (Login)
登录按钮
cmdLogin
CmdLogin_False.
GIF
登录
1
登录取消按钮
cmdLoginCancel
cmdLoginCancel. GIF
取消
2
单据新
增界面
(New)
关闭按钮
cmdNewClose
cmdNewClose_Fal se..GIF
关闭
Button
1
新增按钮
cmd