Domino5编程规范

《Domino5编程规范》由会员上传分享，免费在线阅读，更多相关内容在应用文档-天天文库。

1、Domino5.x编程规范Domino5.x编程规范试行版-10-Domino5.x编程规范1总则31.1文档约定31.2基本要求31.3可读性要求31.4结构化要求31.5正确性与容错性要求41.6复用性要求42工程规范42.1Domino配置要求42.2文件目录52.3Notes客户端要求53技术细节及规范53.1数据设计元素命名53.1.1数据库命名53.1.2表单命名53.1.3视图命名63.1.4Script库命名63.1.5域命名63.1.6页面命名63.2代码风格73.2.1类的命

2、名73.2.2过程命名73.2.3变量命名73.2.4常量命名73.2.5代码组织73.2.6注释风格83.3表单设计规范93.3.1表单构成93.3.2HTML设计元素93.3.3程序代码的组织93.3.4表单的绘制94数据库的发布105后记10-10-Domino5.x编程规范1总则1.1文档约定所有代码示例仅作为描述规范的工具，与具体的语言无关。Domino中所有的可用语言均需要遵照该规范进行代码书写。该规范假定读者具有相当的Domino开发经验，初学者如对该文有理解上的障碍请与文档编写者

3、或责任人联系，也可通过其他途径获得支持。1.2基本要求ü数据库设计清爽，结构简单，便于维护。ü程序结构清晰，简单易懂，单个函数的程序行数一般不得超过100行。ü务求代码精简，避免垃圾代码或注释。ü在能够满足功能与性能要求的前提下,尽量使用标准库函数和公共函数。ü不可随意定义全局变量，尽量使用局部变量。ü逻辑运算复杂的场合,使用括号以避免代码阅读障碍。1.3可读性要求ü可读性第一，效率第二。ü保持注释与代码完全一致。ü每个源程序文件，都有文件头说明，说明规格见注释规范。ü每个函数，都有函数头说明，

4、说明规格见注释规范。ü主要变量定义或引用时，注释能反映其含义。ü常量定义有相应说明。ü处理过程的每个阶段都有相关注释说明。ü在典型算法前都有注释。ü利用缩进来显示程序的逻辑结构，缩进量一致为2个空格。ü循环、分支层次不要超过五层。ü注释可以与语句在同一行，也可以在上行。ü空行和空白字符也是一种特殊注释。ü一目了然的语句不加注释。ü注释的作用范围可以为：定义、引用、条件分支以及一段代码。1.4结构化要求ü禁止出现两条等价的支路。-10-Domino5.x编程规范ü禁止使用GOTO语句。ü用IF语句

5、来强调只执行两组语句中的一组。禁止ELSEGOTO和ELSERETURN。ü用CASE实现多路分支。ü避免从循环引出多个出口。ü函数只有一个出口，简单的结构清晰的方法除外。ü不使用条件赋值语句。ü避免不必要的分支。ü不要轻易用条件分支去替换逻辑表达式。1.1正确性与容错性要求ü程序首先必须正确无误，然后考虑代码的优雅。ü无法证明你的程序没有错误，因此在编写完一段程序后，应立即复核。ü修正一个错误时可能产生新的错误，因此在修改前首先考虑对其它程序的影响，程序的每个模块尽量封装起来。ü所有变量在调用

6、前必须被初始化（LotusScript语言无此要求）。ü对所有的用户输入，必须进行合法性检查。ü不要比较浮点数的相等，如：10.0*0.1==1.0，不可靠。ü程序与环境或状态发生关系时，必须主动去处理发生的意外事件，如数据库能否打开。ü单元测试也是编码的一部份，提交测试的程序必须通过个人单元测试。1.2复用性要求ü经常重复使用的、并能够完成相对独立的功能部件应抽象为公共模块或类。ü公共模块或类应充分运用OO思想，避免或减少外部依赖，考虑独立性、封装性。2工程规范2.1Domino配置要求ü必须

7、创建certlog.nsfü必须创建domcfg.nsfü由于中文版Domino下domcfg.ntf数据库的表单错误地被翻译为中文，造成系统某些功能无法正常发挥作用，请手工修正，具体的操作方法请参考技术部相关文档。ü无特殊要求的开发环境，请启用基于会话的验证，单服务/多服务器模式均可。ü按实际开发产品或项目中涉及的人员角色、岗位来注册测试用户。ü项目技术负责人在Domino目录中建立项目团队群组，并设置相关开发模块的存取权限。-10-Domino5.x编程规范1.1文件目录ü禁止直接将应用数据

8、库存放于数据目录的根下ü必须创建usr目录和prj目录ü在usr目录下，每位开发人员可以建立自己的私人主目录ü在prj目录下，每位项目经理可以建立项目主目录1.2Notes客户端要求ü整理个人工作台，按数据库类别或项目组织个人工作台或书签ü本地数据库目录不允许存放项目数据库文件（项目经理出于备份或屏蔽设计的目的除外）。ü离开个人计算机，必须注销Notes并锁定Windows系统。2技术细节及规范2.1数据设计元素命名2.1.1数据库命名采用字母、数字、下划线的组合进行命名，字母一律使用小写，数据