java语言原理分析.doc

开发质量管理规范开发质量管理规范 JAVA import java awt peer CanvasPeer 例如 import java awt peer CanvasPeer 而不是 import java awt peer 方法命名1 动词 名词 条件 的方式来命名 首字母小写 其他单词首字母大写 2 查询方法 动词采用 get 无条件查询 qry 有条件查询 3 修改 动词采用 mod 4 删除 动词采用 del Public String addStaffRole public String etStaffPrivilege public String modRole public String delRole JAVA For int i 0 i 100 i String c Static String APP ID 注释1 方法头注释 Function 将数据库中获取的字段大写 小写 param list return author wangyz 2010 7 30 配置方法 window preferences java code style code templates comments methods 点击左边的 edit 然后复制进去就可以了 按 alt shift Z 增加注释 2 方法内代码单行注释 if search null 获取父节点 BssOrgList bssOrgFacade getBssParentOrg search else 获取子节点 BssOrgList bssOrgFacade getBssOrg search return SUCCESS 3 成员变量注释 public 的成员变量必须要有注释 直接在变量名后 面增加 如 Static String APP ID 程序标识 proceted private和 package 定义的成员变 量如果名字含义明确的话 可以没有注释 JAVA Date sdate DateUtil getDate DateUtil YYYY MM DD date Date 类型转 String 类型 String date DateUtil getFormate DateUtil YYYY MM DD new Date 其他按照先去定的格式标准 4 2配置文件方面配置文件方面 4 2 1Ibatis 配置文件命名规范配置文件命名规范 Ibatis 配置文件统一放置在 configs 目录下 对于工具生成的配置文件 根据工具生成的命名为准 对于自行编写的 一般采用 模块名 sqlMap xml 的命名方式 比如 system sqlMap xml 4 2 2Ibatis sql 类映射命名规范类映射命名规范 Namespace 以模块名称定义 如 SQL 映射建议以操作动词 操作表名 并在 SQL 块之前加上注释 例如 select b bss org level id from role insert into role JAVA 客户标识 使用单行注释 块注释用于注释正式文档和无用代码 JAVA 分号 放到每条简单语句的结 尾处 注意一个函数赋值或对象赋值语句也是赋值语句 应该以分号结尾 JavaScript 可以把任何表达式当作一条语句 这很容易隐藏一些错误 特 别是误加分号的错误 只有在赋值和调用时 表达式才应被当作一条单独的语 句 5 5 8 2复合语句复合语句 复合语句是被包含在 大括号 的语句序列 被括起的语句必须多缩进四个空格 左大括号 应在复合语句其实行的结尾处 右大括号 应与 左大括号 的那一行的开头对齐 大括号应该在所有复合语句中使用 即使只有一条语句 当它们是控制结 构的一部分时 比如一个 if 或者 for 语句 这样做可以避免以后添加语句时 JAVA 分号 结尾 5 5 8 9 switch 语句语句 switch 语句应如以下格式 JAVA catch variable statements try statements catch variable statements finally statements 5 5 8 11continue 语句语句 避免使用 continue 语句 它很容易使得程序的逻辑过程晦涩难懂 5 5 8 12with 语句语句 5 5 9另外的建议另外的建议 不要使用 with 语句 JAVA 分号 后须跟一个空格 每个 逗号 后应跟一个空格 5 5 11 和和 使用 代替 new Object 使用 代替 new Array 当成员名是一组有序的数字时使用数组来保存数据 当成员名是无规律的 字符串或其他时使用对象来保存数据 5 5 12 逗号 操作符逗号 操作符 避免使用逗号操作符 除非在特定的 for 语句的控制部分 这不包括 那些被用在对象定义 数组定 义 var 语句 和参数列表中的逗号分隔符 5 5 13 作用域作用域 在 JavaScript 中块没有域 只有函数有域 不要使用块 除非在复合语 句中 5 5 14 赋值表达式赋值表达式 避免在 if 和 while 语句的条件部分进行赋值 JAVA 最好能写成 total subtotal myInput value 这样 不