Domino代码优化、编码规范-石振勇.ppt

Domino应用开发规范 表单规则: 1．1 表单命名规则 表单名称统一用中文,尽量能展示该表单的功能和意图. 如果表单名无法展示其意图,或者表单名必须用英文,或者需要对表单做些其他说明,则填写表单的备注. 必须填写表单的别名.别名的可以用英文单词组合或汉语拼音.如果用拼音,在能够容忍的长度内,尽量用全拼。规定：如果名称全拼在16个字之内，用全拼并且每个字的首字母要大写。如果超过16个字，则全用每个字的首字母大写。 表单名无需加”fm”的前缀。但可以按其功能类别加前缀，比如用于区分“核心表单和非核心表单”的前缀 对于不需要用来创建文档的表单，名字用括弧括起来，用以将后台表单和前台表单区分开，如功能性的表单作为后台表单。 表单规则: 1．2 表单的Js Header 表单的Js Header中的函数应尽可能的少。只保留仅与本表单相关的特殊的Js函数。 规定：放在页面里的js函数包要在页面中写明每个包中的函数名称，方便查找和查看。 资源库中的js函数包同时要有同名的说明文件。还要求有一个总体说明文件。 1．3 表单的On KeyDown事件 可以在此函数中限制用户的一些按键，例如： //防止用户CTRL+N,避免繁盛保存冲突 if(event.keyCode==78event.ctrlKey) return false; 表单规则: 1．4 表单的OnLoad Onload中的代码要尽可能的简短，不要写具体的实现代码，只写被调用的函数体即可，目的是为了代码清晰简洁，便于维护。例如： //打开前设置相关状态域 ondocload(); //装载意见 LoadOpinion(); //修改附件链接 ModifyAttachLink(); //上载附件 AddAttach(); 域的规则: 2．1 域的命名规则 可以用英文单词组合或汉语拼音.如果用拼音,在能够容忍的长度内,尽量用全拼。规定：首字母大写用全拼。 域名不要加用以说明域的类型属性的前缀。但可以按其功能类别加前缀，比如用于区分“控制域、数据域、Html用的域”的前缀 域名可以加其功能类型的前缀，用于功能类型有限时。当功能类型几十上百种时，就没意义了。 域的规则: 2．2 文本域容量限制问题 除非一个NotesItem需要在视图或文件夹中显示，后台创建的notesItem一定要将其 IsSummary属性置为False 视图的规则 3．1 视图的命名规则 视图名称统一用中文,尽量能展示该视图的功能和意图. 如果视图名无法展示其意图,或者视图名必须用英文,或者需要对视图做些其他说明,则填写视图的备注。规定：如果视图本身是被调用的在备注中必须写明被谁调用。 必须填写视图的别名.别名的可以用英文单词组合或汉语拼音.如果用拼音,在能够容忍的长度内,尽量用全拼. 规定：如果名称全拼在16个字之内，用全拼并且每个字的首字母要大写。如果超过16个字，则全用每个字的首字母大写。 视图名无需加”vw”的前缀. 对于不需要用于前台显示的视图，名字用括弧括起来成为隐藏视图，用以将后台视图和前台视图区分开 视图的规则 3．3 视图的列 一般应填写列的“标题”属性，用于辨别该列 视图的列的内容的字体应统一设置，一般字号设置为9，字体为宋体，颜色根据客户需要设置，风格应协调统一。 视图的列公式尽可能的简洁，减少计算量。 避免使用时间相关的列公式， 比如@Now, @Created, @Modified. 列尽可能不排序 删除所有不必要的列 视图的规则 3．4 视图的选择公式 避免使用复杂的视图选择公式 视图选择公式避免使用与时间、当前用户相关的函数或命令，如@now,@Today,@UserName都是应该避免使用的 视图的规则 3．5 嵌入视图 视图作为“嵌入元素”嵌入页面或表单时，“要显示的行”属性的数字尽量设置的少些，以提高嵌入视图的打开速度。规定：初始值设为20行，如果用户提出速度问题，可以改为10行，作为第一解决方案。 代理的规则 4．1代理的命名规则 代理的名字可以用英文单词组合或汉语拼音.如果用拼音,在能够容忍的长度内,尽量用全拼. 规定：如果名称全拼在16个字之内，用全拼并且每个字的首字母要大写。如果超过16个字，则全用每个字的首字母大写。 必须填写代理的备注，对代理进行详细的说明。 代理名加用于标明其是否为核心代理的前缀. 代理的规则 4．2 代理的其他规则 对于定时执行的代理，在该数据库正式启用前，或者该定时代理暂时不使用时，取消代理前的复选框，以暂时禁用该代理。 对于那些只为管理者在客户端使用的代理，应设为“私有代理”，防止为他人误用 代理 “Sub Initialize” 中的代码要尽可能的简短，不能超过40行。多个代理中或和其他设计元素中共