Notes编程规范.doc

文件编号：AS/JSGF-001 Notes编程规范 文件状态： [√] 草案 [ ] 正式发布 [ ] 正在修改 文档类别 技术规范 文档编号 AS/JSGF-001 当前版本 1.0.0 拟制人员 开发组 拟制日期 2005-11-20 审核人员 批准人员 生效日期 2005-12-01 目 录 §1. 引言 3 §2. 命名规则 3 §3. 表单样式 4 §3.1. 字体格式 5 §3.2. 表格布局 5 §3.3. 域类型 5 §3.4. 控制域修改权限的考虑 5 §4. 代码编写格式 6 §4.1. 代码样式 6 §4.2. 注释 6 §4.2.1. 目的 6 §4.2.2. 要求 6 §4.3. 其他 7 §4.3.1. 一行只写一个语句 7 §4.3.2. 空行使用 8 引言 本规范定义一个源码级应用程序的开发规范，它是借助Lotus Notes程序语言，在Notes开发环境提供的标准化服务。它可供应用开发人员及系统设计人员使用。 本规范描述开发人员关心的外部特性及设施，而不是描述为达到这些功能采用的内部结构技术。 适用于公司中所有使用Notes作为程序开发语言进行的产品和项目的应用开发。 命名规则 为了让项目中所有的文档具有一致性的，增加可读性，保证产品和项目的可维护性，在命名时用英文为操作或变量等赋予表义性强的名字。给正确的命名，可使程序工程的调试和维护工作大大的改观。认真对待方法命名的工作，不要为了减少键入操作量而降低可理解度。除了广为人知MethodName 参数 参数一般使用名词，首字母小写，大写中间单词的首字母。 例如： parameterName 使用有意义的参数命名，如果可能的话，使用和要赋值的字段一样的名字，例如： Sub Click(Source As Button) End Sub 数组 数组应该总是用这种方式来命名：byte() 表单样式 所有的表单都必须遵守如下的样式规则（严格按以下顺序组织各部分）。 字体格式 表格标题：12号字，黑体，居中 表格中静态文本（标签）：9号字，宋体 表格中域部分（需填写部分）：9号字，楷体 表格布局 页面采用A4标准，长宽为29.7*21，左边距1.5CM，右边距1CM，上边距1CM，下边距1CM。表格为页面的主要内容，表格宽度为21-1.5-1=18.5CM，表格居中对齐，外围边框厚度2，其它为1。 域类型 域类型根据表格内应填写的内容确定，一般为普通文本，日期类的必须将域类型设定为日期，并设定格式为XXXX年XX月XX日，如果月或日小于10，则前面不加0，即只用一位表示；对于签字和盖章域、附图的域必须是RTF类型，并且对于签字、盖章、签署意见这类的域必须是计算的。 控制域修改权限的考虑 为了控制哪些环节、哪些人员可以修改某些域，添加计算文本并对这些设定隐藏公式。如SG-001表，第一行第四列，应设定一个工程地点域，域名为SG00112，文本类型，隐藏公式为!(@Contains(CurrentTransactor;@UserName)@Contains(EditArea;”SG00112”))，意思为如果该表单的当前处理人不是当前用户并且当前处理人的权限域中不包含此域，那么该域不显示出来；虽然不能显示该域，但仍然需要看到不能修改的内容，以计算文本来代替。计算文本的计算公式为对应域的名字，此处为SG00112，隐藏公式为@Contains(CurrentTransactor;@UserName)@Contains(EditArea;”SG00112”)刚好和域的隐藏公式相反。注：域SG00112和计算文本之间必须有个回车符号，否则不能应用不同的隐藏公式。 代码编写格式 代码样式 代码应该排版合理，按功能块分段。 注释 目的 文字说明代码的作用(即为什么要编写该代码，而不是如何编写)，使代码的阅读者不必在他们的头脑中仿真运行代码的执行方法。 明确指出该代码的编写思路和逻辑方法。 提示人们注意到代码中的重要转折点。 文档化 要求 注释遵循的格式 块注释 主要用来描述文件，类，方法，算法等。一般用在文档和方法的前面，也可以放在文档的任何地方。以‘%REM’开头，‘%END REM’结尾。例如： …… %REM 注释 %END REM …… 行注释 主要用在方法内部，对代码，变量，流程等进行说明。与块注释格式相似，但是整个注释占据一行。例： …… /* 注释 */ …… 尾随注释 与行注释功能相似，放在代码的同行，但是要与代码之间有足够的空间，便于分清。例： int m=4 ; ‘