JSP 编码规范
一、书写格式 代码书写格式整齐统一、层次清晰便于阅读。 ? 缩进 TAB 键统一为 4 个空格 ? 赋值语句(=)及逻辑判断符(> < != &;&; ||...etc)左右各空一格 ? 算术运算符左右各空一格 ? if/while/switch 之类的语句右边空一格 ? 每个成员函数内部各个子功能之间用一个空行 ? 公用成员放在程序的最前面,私用成员在后。 二、恰当地使用注释 注释应简洁、清楚。 ? 不提倡使用/* 和 */来注释, 最好使用//来注释。如果是对某一段程序(算法/结构)的注 释, 在程序头直接用//再空一格来进行说明,一行不要超过 80 字符 ? 注释就占程序的 30%,如 10 行代码中就有不小于 3 行的注释。 三、关于命名 1、变量的命名 除了循环变量 i,j,k...之外, 文件、 类、 (成员)变量、 (成员)函数的命名要有意义, 大小写相间, 一目了然; 成员变量、函数(Method)的首字母小写 全局变量名称以“g_”开头。 2、.类的命名和定义 自定义的类(包括 Servlet、Bean)的首字母为大写。在程序中引用时,其对变量名的首字 母小写 Servlet、Bean 定义名称时,其末尾应加上 ServletBean 后缀。以便于区分。 如: (GetNewGuest.class) …… GetNewGuest getNewGuest = new GetNewGuest(); …… ArticleBean articleBean = null;
包(package)名均为小写。 格式为:com.founder.<项目名>.<模块名> 3、匈牙利命名法 命名时可以遵循匈牙利命名法 它通过在数据和函数名中加入额外的信息以增进
程序员对程序的理解。 如字符串,前面加上 str;. String strTemp = new String(“This is ……”); 如果定义两个实例,可以这样合起来写: MyClass myClassTemp1,myClassTemp2;
四、局部变量一定要初始化 如果你声明一个变量,不要以为编译器会自动将之赋零值!你随手给它赋个初值并不麻烦, 却会使程序更可靠, float fTemp = 0.0; 成员函数: 五、.成员函数: 成员函数 成员函数的功能一定要单一; 实现其功能时不要过分追求技巧, 函数体不能过长 六、.数组和缓冲区的使用 数组和缓冲区的使用 对数组和缓冲区进行检查,防止越界,尤其是变长的情况下 七、.尽量不要用 goto 语句 尽量不要用 特别谨慎使用 goto 语句,最好别用它 尽管 goto 语句在某些特殊的情况下(比如编译器中)还很管用, 但它破坏了整个程序的结 构,尤其使用 goto 嵌套时,更让人一头雾水(很久以前就有人提出取消它)。所以不到万不得 已时刻不要用它, 可以用 break,continue 之类的语句替代之。 八、数应该是单人口、单出口的 数应该是单人口、 所有成员函数尽量是单入口,单出口 也许多出口的程序写起来更简洁,意义也更明了。但出了
问题调试时会很难定位,所以宁可 多用一些 B
OOL 变量,多加些判断,保证单出口: 例如: public String getValue(int value) { String reault = null; if (ivalue >0) {… result = “xxxx……”; } else { result = “aaaa……”; … } return bRet; } 九、调用函数应合法 调用函数时要严格按照接口规范 严格按照函数的输入要求给它合适的参数
十、.单元测试 单元测试 自己做代码内部(单元)测试时,必须做到语句覆盖,并且特别要注意边界值的覆盖 要让每个语句都被执行过,并且边界值(最大和最小)也被测试过。你在程序中写的各种情况 都可能在用户那里出现 十一、 十一、静态检查 代码写完后要尽可能多的做一些静态检查(Debug 调试可是很费神费时的)。尤其是对算法和 数据管理(比如对文件存取)部分 十二、 十二、文件存放 代码文件的存储位置固定,图片文件存放在统一的目录 Picture 下,如果各个模块有自 己的图片文件,可以创建子目录来完成。 公用函数脚本文件放在统一的目录 Scripts 下。 每个功能模块创建一个
JSP 文件存放目录。 结束语: 希望大家在遵守规范的前提下,通过自己的努力,开发出功能齐备、风格统一、性能稳 定的一流
软件产品。