posts - 12, comments - 4, trackbacks - 0, articles - 0

代码规范(转)

Posted on 2007-10-31 17:27 Edward's 阅读(302) 评论(0)  编辑  收藏 所属分类: 代码规范

1. 每个文件的头部注释: 版权说明、版本号、生成日期、作者、内容、功能、与其它文件的关系、修改日志等,头文件的注释中还应有函数功能简要说明;

2. 函数头部应进行注释:函数的目的/功能、输入参数、输出参数、返回值、调用关系(函数、表)、作者或修改人等;

3. 对变量的定义和分支语句(条件分支、循环语句等)必须编写注释;

4. 自己特有的命名风格,要自始至终保持一致,不可来回变化;

5. 类命名标准: 由两个或以上的相近意义的英文单词组成,首字母大写;

6. 一个类里面只能实现一个单据或一个功能的不同操作方面,尽可能减少类之间的耦合性;

7. 一些通用功能,都分类封装成不同的实用操作类;

8. 对以前的对象或函数重构或重命名时, 必须由修改人搜索以前的所有调用并替换,同时通知其它人以后使用新的调用;

9. 注释格式 /** * Setting to true will enable the display of debug information. * * @param d A boolean. * @return An Email. * @throws EmailException * @version Version * @author Author * @since 1.0 */

10. 类包规范: path.crm(itm,system,basic,oa,wms,mrp,scm).entity(manager),按模块分开类,同时实体类与操作类分开,映射文件跟实体类同目录;path.util下为实用类;Servlet映射为二级目录,目前为/path/system;

11. 页面不允许RS对象引用,全部用List或HashMap来实现;

12. 参数传递尽可能使用实体类, 没有实体类的使用HashMap;

13. 方法重载时, 可替换的不能使用重载;

14. 严格按照代码缩进格式进行代码书写,包括各种操作与分隔符号两边的空格;

15. 模糊搜索关键字,可以输入如"ab,abc"以逗号分隔的多个关键字进行搜索;

16. 变量命名规则: 数据类型简写+首字母大写的变量英文名称, 如果是全局变量加上小写g, 如: gszLimitString, gnModuleFlag, gnPageSize;

17. 程序中,SQL语句不能包含方括号, SQL语句中的表别名不能加AS,用空格代替;

18. SQL字符串,不能直接拼接字符串变量,用SET方法实现变量赋值,避免非法字符串变量引起安全问题;

19. 必须随时关闭所用的ResultSet,Statement对象,最好用finally实现,避免错误时没有关闭的问题;

20. 附件管理: 文件大小统一用text.formatFileSize()进行格式化;查看与下载链接用SPAN标签;

21. 其它详细的请参见公司的“软件编程规范检查”;

 

ps:Java语言编码规范(Java Code Conventions):

http://www.huihoo.org/code/java_code_conventions.html


只有注册用户登录后才能发表评论。


网站导航: