java代码编写规范 java代码编写程序的基本规范.doc
内容要点:
Java 代码编写程序的基本规范第 11 页 共 11 页 母分割。3、jsp 传递参数命名规则参照 class 变量命名规划。4、文件命名其它常见规范5、jsp 主页面(游览功能) XxxxIndex.jsp (一般记录的删除在此页面做连接) 6、jsp 添加功能页面 XxxxAdd.jsp 7、jsp 修改功能页面 XxxxModify.jsp 8、jsp 删除功能页面 XxxxDel.jsp Java 代码编写程序的基本规范第 10 页 共 11 页 5、尽量不要编写依赖于其他方法内部实现的方法。 6、避免设计多余参数方法,不使用的参数从接口中去掉。 7、用注释详细说明每个参数的作用、取值范围及参数间的关系。8、检查方法所有参数输入的有效性。 9、检查方法所有非参数输入的有效性,如数据文件、公共变量等。 10、方法名应准确描述方法的功能。 11、避免使用无意义或含义不清的动词为方法命名 12、方法的返回值要清楚、明了,让使用者不容易忽视错误情况。 13、明确方法功能,精确(而不是近似)地实现方法设计。 14、减少方法本身或方法间的递归调用。 (递归优点:是程序易读,易编程;缺点:效率不高,增加了系统的开销,每递归一次,栈内存就多占用一截。 )1.5 jsp 规范(使用英文单词,最大长度20位)1、jsp 目录命名规范参照 Package 命名规则,用小写单个单词作为目录名。2、jsp 文件名规范参照 class 命名规则,采用首子母大写,多单词间采用大写字 Java 代码编写程序的基本规范第 9 页 共 11 页 if ((I) = 42) { // 错误 - 括号毫无意义 if (I == 42) or (J == 42) then // 正确 - 的确需要括号1.3.3 注释// 注释一行 /* ...... */ 注释若干行 文档注释: /** ...... */ 注释若干行,并写入 javadoc 文档 在每个源文件的头部要有必要的注释信息,包括:文件名;版本号;作者;生成日期;模块功能描述(如功能、主要算法、内部各部分之间的关系、该文件与其它文件关系等。 在每个函数或过程的前面要有必要的注释信息,包括:函数或过程名称;功能描述;输入、输出及返回值说明;调用关系及被调用关系说明等。1.4 方法1、方法的规模尽量限制在 200 行以内。 2、一个方法最好仅完成一件功能。 3、为简单功能编写方法。 4、方法的功能应该是可以预测的,也就是只要输入数据相同就应产生同样的输出。