JSP程序设计命名规约.docVIP

目录 1. Web应用程序开发的合理化 1 2. 使用JSP语句的规则 1 3. JSP记述上的注意点 5 4. SQL文的标准化 5  Web应用程序开发的合理化 JSP开发中，为使客户端的显示最适化，设计了以下的开发基准： No. 规则 目的 1 服务器端程序中，应尽量避免文件的读写。 减轻I/O等待时间 2 在Script的代码中，不必要的注释掉的行一定要削除。 提高编译的速度 3 标准HTML语句和Script语句不要混杂在一起。 减轻服务器CPU的负担 提高代码可读性 4 对手动输入数据的检测应放在客户端，不要放在服务器端。 减轻服务器CPU的负担 5 尽量在应用程序中不使用Session语句，每页开放Session资源。 减轻服务器存储空间的负担 6 对数据库操作命令应尽量能达到重用。 减轻服务器的负担 7 当有复杂的处理时，不要用Script语句实现，要使用JavaBean等开发成应用软件包，然后调用。 提高应用程序的标准化 8 尽量采用Bean组件，减少页面代码 增加可读性，便于维护 使用JSP语句的规则 [变量的起名规则] 表示变量内容的名称前，应加上表示类型的三个英文字符。下表是Java变量应使用的字符： No. 内部处理类型 前置词 使用例 1 布尔型boolean bln blnFound 2 位码型byte byt bytRasterData 3 日期（时刻）型date / time dtm dtmStart 4 倍精度浮点小数型double dbl dblTolerance 5 错误型error err errOrderNum 6 整数型integer int intQuantity 7 长整型long lng lngDistance 8 对象型object obj objCurrent 9 单精度浮点小数型single sng sngAverage 10 文字列型string str strFirstName [表示变量范围的前置词] No. 适用范围 前置词 使用例 1 过程级（procedure level） 无 dblVelocity 2 局部级（script level） s_ s_blnCalcInProgress 3 局部级（script level） s_ p_blnCalcInProgress [异常捕捉] 对数据库操作、类型转换等操作中，应尽量采用try…catch表述，尽量减少错误消息在页面显示，实现代码无故障运行。 [表示内容的变量名和过程名] 在变量名和过程名的名称本体部分中，有必要用大写和小写的英文字符来表示这一名称下的用途。因此，过程名称，例如InitNameArray或者CloseDialog这样用动词开始的起名方式是必要的。 某一被频繁使用的名称，或长时间被使用的名称，应在起名时使用标准形式的省略形式，名称的长度要适当。一般变量的名称不要超过32个英文字符。使用省略形的时候，必须在应用范围内全体统一。比如，一个或者数个Script内，如果Cnt和Count都存在，就会产生混乱。 [对象的命名规则] No. 对象类型 前置词 使用例 1 Check box chk chkReadOnly 2 Combo box / Dropdown / List box cbo cboEnglish 3 Command button cmd cmdExit 4 Frame fra fraLanguage 5 Label lbl lblHelpMessage 6 Line lin linVertical 7 List box lst lstPolicyCodes 8 Text box txt txtLastName [注释的记述规则] 各个过程的开头，需要写简单的注释以介绍这个过程的机能。不需要写有关机能的实现方法等详细的记述。由于程序代码根据要求会来回变更、修改，因此也需要最后把不要的注释或者错误的注释削除掉。 当程序中出现用途不明确的外部变量，或者在特定范围内需要某一变量的场合下，关于变量的说明的注释是必要的。又或者，函数的返回值或函数需要参照的变量在当前过程中被改变的其它变量，也需要在过程的开头用注释记述有关的信息。 下表是过程开头需要注释的内容的标题。实际的使用例，请参照下页的代码编写。 No. 注释标题 注释的内容 1 用途 过程的作用。 2 外部来的影响 根据状况对本过程有影响的外部变量、控件、及其他要素的一览。 3 对外部的影响 对于外部变量、控件、及其他要素，本过程的影响的一览。 4 外部变量 不明确的各变量的说明。 5 返回值 返回值的说明。