《程序员编码要求.doc》由会员分享，可在线阅读，更多相关《程序员编码要求.doc（12页珍藏版）》请在金锄头文库上搜索。
1、 湖北国际软件外包人才培养基地 程序编码通用要求程序编码通用要求程序员应遵守如下编码要求。1 界面设计部分1.1 界面的总体原则1.2 必须显示公司名称、系列软件名称、版本号、版权等相应内容。（主要是启动画面）1.3 整体界面必须符合一般Windows风格或流行的界面标准。1.4 同一系列产品的总体风格应一致。（比如：登录，按钮名称，图标样式等等）。1.5 主菜单、子菜单、弹出菜单以及窗口中的按钮（除“确定”、“取消”按钮外）都必须设置快捷方式。（菜单快捷方式包括键盘快捷键喝系统快捷键都要有，对于用户常用的功能提供系统快捷键。）1.6 必须使所有功能都能被鼠标、键盘所访问（尤其是键盘）。（ES
2、C键退出对话框，在输入信息时，回车、Tab键自动到下一输入项。）1.7 尽量提供鼠标右键功能，方便用户操作。2 控键的位置2.1 重要或频繁访问的元素应当放在显著的位置上。2.2 位置必须符合用户的视觉习惯（从左到右，从上到下）。2.3 必须按照信息和功能按逻辑分组。2.4 按钮的位置必须与界面其他控键保存位置上的对应，上下保持对称，左右与第一行控键水平。3 界面元素3.1 相同类型、相同功能的窗体必须保持一致性：类型、尺寸、背景、颜色。3.2 在同一个系列的软件中相同类型的控键应保持一致性：尺寸、颜色、字体、标题、内容（标准按钮的长度XXX，高度YYY）。3.3 在同一个系列的软件中，所有的
3、表格、单元格应保持一致（标准单元格大小为高0.YYcm，宽X.Xcm）。3.4 分组的一致性：按照相应的业务分类进行控键的分组，以便于用户按照分组进行操作：同时也使得界面减少冗余内容。（比如关闭，确定、取消等按钮应该与增加、修改、删除按钮分开等等）。3.5 各菜单项的名称必须合理，不应引起理解的二义性。3.6 对应窗口上的名称（caption）必须与各菜单项的名称一致。（对于二次窗口的caption命名方法，可参考：比如主菜单中用户设置中增加对话框的caption为“用户设置 增加”，以此类推）；3.7 当信息在一屏内无法完全显示，必须加上滚动条，且符合Windows标准（即当显示的内容超过显
4、示位置的时候）。3.8 软件中菜单和控件，必须按照相应的操作用户以及当前的状态进行控制隐现，保证用户能够根据相应的菜单和控件的颜色，判断当前允许的操作。3.9 凡是单击菜单项目能够反映对话框的，都应在相应菜单后用省略号表示：凡是在该菜单还有子菜单的，应在该菜单后用三角形表示。3.10 控键状态的缺省值应按照符合相应制度的、用户使用频繁的、达到相应控制的选项进行设置（不清楚的，可按照详细设计的要求）。3.11 应都有输入字符类型和长度的限制，且在非法操作后，确定，应及时提示。3.12 所有输入框的显示的长度必须与输入且能保存的长度匹配（不应过长或过短），并且注意不同字符集的内容。3.13 有记录
5、list和修改功能的对话框中必须提供鼠标双击list代表修改的功能。3.14 动感：控键的选取与执行应该有清楚的体现。4 空白空间的使用4.1 控键间要有适当的空白空间。4.2 控键间隔一致，垂直和水平方向向上对齐。5 保持界面的简明5.1 控键安排简单、有效、便于用户使用。5.2 资料的版面排列应整齐美观，显示正确。能明显区分上下资料。避免在同一界面上存放太多的控键，保持界面的清爽。6 颜色6.1 一般采用柔和、中性化色彩。（一般情况下使用Windows或是Office惯用颜色，即蓝，白，灰。）6.2 尽量限制程序所用颜色，保持色调一致。6.3 软件的分辩率设置应同一使用800*600，颜色
6、使用增强16色。6.4 设计时应考虑到色盲用户的特殊情况，减少相应的过于鲜艳的色彩。6.5 所有的查询均应使用黑底白字，在计算结果中用粗体表示着重。7 图标7.1 在已有标准的图标图像的情况下，必须使用标准的图标图像（新建、打开、保存、预览、打印、剪切、复制、粘贴、删除、字体、检索、退出等）。7.2 特殊项目中，应根据用户的实际需求选用与相应的业务符合的、合理的图像与图标。（若是Graphics目录中的图标不尽合理，可以寻求美工的帮助）7.3 图表的设计应合理且简洁生动美观，主题鲜明。7.4 图标都应有tiptext，内容一般情况下与该功能在菜单中的名称一致，必要的时候可以加以祥述，但字数不宜
7、过长。8 光标8.1 光标的形状应随不同的状态改变不同的形状。8.2 对执行完成所需时间较长的操作应改变鼠标状态或提供状态（进程条）显示表示执行状况。9 字体9.1 字体、大小应保持一致，在目前的产品系列中：界面的菜单、按钮、快捷按钮、图标等固定内容，字体必须采用宋体9号字；界面中的列标显示内容，默认使用宋体12号字。10 可用性设计10.1 功能的可发现性10.1.1 用户能在无须查看帮助的情况下了解功能、完成操作。10.1.2 菜单排列，一般情况Windows或是Office惯用顺序，牵涉到业务的菜单功能必须按照业务顺序排列。10.2 当用户或系统出错时与用户交互。10.3 创建容易理解的
8、对话框10.3.1 使用一般用户就能理解的语言来描述问题的关键。10.3.2 使用标准类型的对话框，在以下所列出的情况下（！警告：删除、修改后没有保存退出，内存不足caption为警告 ？帮助，询问：caption为帮助，询问 i 提问：一般提示、操作信息caption为提示 )10.3.3 不输入任何数据直接保持，应提示“没有可保存的记录”。10.3.4 修改资料后退出或是关闭，应提示“资料已修改，是否覆盖远记录？”10.3.5 要注意关键值相同的现象，不允许有重复的记录时应有相应的提示。10.3.6 查询时，若不满足基本的查询条件，应不允许查询。10.3.7 删除或修改项目或内容时，应判断
9、该项目是否有牵连的计算内容或已经使用的情况，若有则不允许删除或修改。10.3.8 显示空记录时，应不允许操作（计算、打印等）。10.3.9 在本机内进行存储时，当覆盖已有文件时，应提示“文件已存在，要替换吗？”。10.4 贴近用户的模式10.4.1 帮助与文档10.4.1.1 尽量使用用户顺序的语言老描述。10.4.1.2 提供关键词、关键代码的快速查找功能。在重要窗口中提供帮助按钮。10.4.2 提示10.4.2.1 “这是什么”帮助10.4.2.2 提供标准的Windows的“这是什么”帮助功能。10.4.3 状态显示10.4.3.1 对不能立即执行完成的功能提供状态显示表示执行状态（进度
10、条、鼠标指针的变化）。10.4.3.2 当鼠标停留在某图形后图标上时应该显示描述功能的卷标。（三个点表示浏览的按钮应有Tiptext“浏览”提示）10.4.4 向导：对需长时间安装过程应该提供向导服务，停留时间间隔应短一点。11 接口部分w 输入的实参个数必须等于形参的个数w 实参与形参的属性要匹配w 传入的实参顺序应该与形参相同w 值参不能改变w 定义的全局变量名不能与模块中的名称相同w 如果模块进行I/O1 文件属性是否正确？2 打开/关闭状态是否正确？3 格式规范是否与I/O状态匹配？4 缓冲区的大小是否匹配记录大小？5 文件是否在使用前打开？6 文件结束条件是否处理过？7 I/O错误是
11、否处理过？8 在才、输出错误中是否有任何原文字信息？12 内部的数据结构 不能存在以下错误：w 不正确的输入w 不正确的初始化或缺省值w 不正确的变量名w 不一致的数据类型w 上溢、下溢、地址冲突13 错误处理w 必须采用一般用户就能理解的语言来描述错误w 产生的错误应该与试图捕获的错误一致w 已经捕获到异常，由于处理不正确，导致一系列错误，应该正确处理捕获到的异常w 错误的描述对最终确定错误所在应该提供足够的帮助信息14 控制结构测试w 条件测试当判断条件为真或假时，程序运行都应该正常w 数据流测试单元的数据流应该符合系统设计的数据流w 循环测试当循环体第一次执行，中间某次执行，最后一次执行
12、都应当运行正常15 命名规范15.1 一般规范：程序中变量、对象、过程、函数的命名由前缀和有意义的具体名字部分组成。前缀指明作用范围，类型和其它指定的含义，且均为小写。具体名字部分一般由有意义的英文单词或英文单词缩写组成，且一般英文单词首字母大写，其它小写。15.2 变量命名：变量名以小写字母为前缀表示变量的类型，例如：intCharacterCounter说明此变量是一个整数（int），并表示是一个字符计数（CharacterCount）。具体规定各前缀分别代表的变量类型如下：前缀 含义 VB定义 举例bln 布尔型 Boolean blnFoundbyt 单字节型 Byte bytRast
13、erDatacur 货币型 currency curRevenuedbl 双精度型 Double dblTolerancedtm 日期型 Date(Time) dtmStartint 整形 Integer intQuantitylng 长整形 Long lngDistanceobj 对象型 Object objCurrentstr 字符串型 String strFNamesng 单精度型 Single sngAveragecol 集合 Collection colWidgetsudt 自定义型 User-defined type udtEmployeevar Variant varCheckSumerr Error errOrderNum1 用小写字符加下划线前缀表示变量的存在范围属性。例如：glngHDC说明此变量是全局变量（g），且是个长整形的句柄（lngHDC）。 前缀 含义 无 一般过程中的局部变量 c const常量 s 静态变量 m Form中的局部全局变量，其它Form中的过程无法调
