Notes编程规范.doc

Notes编程规范文件编号：AS/JSGF-001 Notes编程规范文件状态： 草案 正式发布 正在修改文档类别技术规范文档编号AS/JSGF-001当前版本1.0.0拟制人员开发组拟制日期2005-11-20审核人员批准人员生效日期2005-12-01目 录1.引言32.命名规则33.表单样式43.1.字体格式53.2.表格布局53.3.域类型53.4.控制域修改权限的考虑54.代码编写格式64.1.代码样式64.2.注释64.2.1.目的64.2.2.要求64.3.其他74.3.1.一行只写一个语句74.3.2.空行使用81. 引言本规范定义一个源码级应用程序的开发规范，它是借助Lotus Notes程序语言，在Notes开发环境提供的标准化服务。它可供应用开发人员及系统设计人员使用。本规范描述开发人员关心的外部特性及设施，而不是描述为达到这些功能采用的内部结构技术。适用于公司中所有使用Notes作为程序开发语言进行的产品和项目的应用开发。2. 命名规则为了让项目中所有的文档具有一致性的，增加可读性，保证产品和项目的可维护性，在命名时用英文为操作或变量等赋予表义性强的名字。给正确的命名，可使程序工程的调试和维护工作大大的改观。认真对待方法命名的工作，不要为了减少键入操作量而降低可理解度。除了广为人知通用的和公司专门作了规定的单词以外，不要自行使用缩写，由缩写方法名组成的代码很难理解和维护。 表单命名采用名称和别名相结合的方式。例如SG-001表，表单名称为“SG-001 工程质量事故报告”，别名为“SG-001”，请注意，表单名称里编号和汉字名称中间有个空格。实际命名时，在表单名称一栏输入“SG-001 工程质量事故报告| SG-001” ，即将名称和别名用竖线“|”分隔后直接粘贴到表单名称中，Notes自动识别别名。 域命名规范l 表格内域表单别名（去掉-号）+行号+列号，例如SG-001表中第二行第四列，应填写面积/高度，此域为第二行的第二个需要填写的域（注：标签类不需输入的单元格不计算在内），因此此域命名为SG00122，SG001表示表单别名去掉“-”号的部分，第一个2表示第2行，第2个2表示第2个域，行号、列号固定为1位如果超过9，用字母A、B、C接续，全部采用大写。l 其它域其它域为除了表格之外的域，如每个表格质监站都要签字、签署意见，因此在表格底部设定三个域JDSign（签名域）、JDComment（签署意见域）、签字日期域。 变量变量一般使用名词，首字母大写，大写中间单词的首字母。例如： CompanyName不要用_或&作为变量名称的第一个字母；单字符的变量名一般只用于生命期非常短暂的变量。i，j，k，m，n一般用于integers；c，d，e一般用于characters；如果变量是集合，则变量名应用复数。 常量常量的名字都大写，单词间以_隔开，并且指出完整含义。 MAX_VALUE 方法方法（method）名第一个单词一般是动词，首字母大写，大写中间单词的首字母。例如：ShowMethodName 参数参数一般使用名词，首字母小写，大写中间单词的首字母。 例如：parameterName 使用有意义的参数命名，如果可能的话，使用和要赋值的字段一样的名字，例如：Sub Click(Source As Button)End Sub 数组数组应该总是用这种方式来命名：byte()3. 表单样式所有的表单都必须遵守如下的样式规则（严格按以下顺序组织各部分）。3.1. 字体格式表格标题：12号字，黑体，居中表格中静态文本（标签）：9号字，宋体表格中域部分（需填写部分）：9号字，楷体3.2. 表格布局页面采用A4标准，长宽为29.7*21，左边距1.5CM，右边距1CM，上边距1CM，下边距1CM。表格为页面的主要内容，表格宽度为21-1.5-1=18.5CM，表格居中对齐，外围边框厚度2，其它为1。3.3. 域类型域类型根据表格内应填写的内容确定，一般为普通文本，日期类的必须将域类型设定为日期，并设定格式为XXXX年XX月XX日，如果月或日小于10，则前面不加0，即只用一位表示；对于签字和盖章域、附图的域必须是RTF类型，并且对于签字、盖章、签署意见这类的域必须是计算的。3.4. 控制域修改权限的考虑为了控制哪些环节、哪些人员可以修改某些域，添加计算文本并对这些设定隐藏公式。如SG-001表，第一行第四列，应设定一个工程地点域，域名为SG00112，文本类型，隐藏公式为!(Contains(CurrentTransactor;UserName)&Contains(EditArea;”SG00112”)，意思为如果该表单的当前处理人不是当前用户并且当前处理人的权限域中不包含此域，那么该域不显示出来；虽然不能显示该域，但仍然需要看到不能修改的内容，以计算文本来代替。计算文本的计算公式为对应域的名字，此处为SG00112，隐藏公式为Contains(CurrentTransactor;UserName)&Contains(EditArea;”SG00112”)刚好和域的隐藏公式相反。注：域SG00112和计算文本之间必须有个回车符号，否则不能应用不同的隐藏公式。4. 代码编写格式4.1. 代码样式 代码应该排版合理，按功能块分段。4.2. 注释4.2.1. 目的 文字说明代码的作用(即为什么要编写该代码，而不是如何编写)，使代码的阅读者不必在他们的头脑中仿真运行代码的执行方法。 明确指出该代码的编写思路和逻辑方法。 提示人们注意到代码中的重要转折点。 文档化4.2.2. 要求 注释遵循的格式l 块注释主要用来描述文件，类，方法，算法等。一般用在文档和方法的前面，也可以放在文档的任何地方。以%REM开头，%END REM结尾。例如：%REM注释%END REMl 行注释主要用在方法内部，对代码，变量，流程等进行说明。与块注释格式相似，但是整个注释占据一行。例：/* 注释 */l 尾随注释与行注释功能相似，放在代码的同行，但是要与代码之间有足够的空间，便于分清。例：int m=4 ; 注释 如果一个程序块内有多个尾随注释，每个注释的缩进应该保持一致。 注释应语言简炼、易懂而又准确，所采用的语种首选是中文，如有输入困难、编译环境限制或特殊需求也可采用英文。 使用完整的语句。虽然不必将注释分成段落（最好也不要分成段落），但应尽量将注释写成完整的句子。 注释一定出现在要注释的程序段前，不要在某段程序后书写对这段程序的注释，先看到注释对程序的理解会有一定帮助。如果有可能，在注释行与上面代码间加一空行。 在执行统一任务的各个语句组之间插入一个空行或注释。好的代码应由按逻辑顺序排列的进程或相关语句组构成。 为了从视觉上突出注释与它的代码之间的关系，请将注释缩进，使之与代码处于同一个层次上。 每个方法都应有一个注释标头。方法的注释标头可包含多个文字项，比如输入参数、返回值。 使用多个行尾注释时（比如用于方法顶部的多个变量说明），应使它们互相对齐。这可使它们稍容易阅读一些。4.3. 其他4.3.1. 一行只写一个语句不论是变量声明，还是语句都不要在