文档介绍：J2EE项目开发规范JAVA编码规范命名规范包命名包名称必须全部用小写。命名方式:..。类命名类名以英文单词取名,首字母必须大写,多个英文单词以大写字母间隔,避免使用单词的缩写,除非它的缩写已经广为人知,如HTTP。类名中不允许‘_’、‘-’等符号。属性/local变量命名定义属性的位置,在类定义的开始,按照public,protected,package,private顺序放置。定义local变量尽量在那段代码的开始处,如方法的开始处。如果是if,for,while段,尽量在左大括号“{”的下一行处定义要使用的local变量。尽量用相同含义英文单词表示,不允许‘_’、‘-’等符号,如:custName。第一个字母小写,中间单词的第一个字母大写。不要用_或&等符号作为第一个字母。 单字符的变量名一般只用于生命期非常短暂的变量。如:i,j,k,m,n一般用于int。如果变量是集合,则变量名应用复数,即以小写s结尾。例如:序号变量名称注释1strfileName“文件名”字符串类型2intfileCount“文件总数”整型3strnames多个“文件名”ount常量命名所有常量名均全部大写,单词间以‘_’隔开。例如:序号常量名称注释1MAX_NUM最大数2publicstaticfinalStringFUNCTION_LIST="function_list";…3……方法命名方法命名采用“动作+属性”的方法。并且,动作以小写字母开始,属性以大写字母开始。常用的动作有:is、get、set、save、add、del等。例如:getName、setName、isSysManager、saveXXX、mdfXXX、delXXX等。规则名称规则说明新增数据addXXX修改数据updateXXX变更数据alertXXX删除数据delXXX查看详细信息viewXXX查询数据queryXXX进入某个功能页面entryXXX下一步next、nextToXXX或entryXXX其他命名开发人员如果遇到上述表格中未列举的类型,请书面通知相关管理人员,由管理人员集中更新列表内容,不得擅自启用未经确定的新变量前缀。编码规范程序基本构成公用元素公用元素指“公用变量”、“公用类”等,由于公用元素对程序中所有类都是可见的,故对它们的修改将会对整个程序造成影响。“公用变量”过多也会破坏数据的隐藏性,与“面向对象编程”的规范不符。所以,公用变量的使用请慎重考虑。函数返回值注意函数返回值的初始化。代码段注释“//”注释用于对程序的注解等。“/*....*/”注释用于对程序修改时临时删除部分程序代码。注:是否作为“临时代码删除和对程序的注释”仅作为参考,根据具体情况而定设定初值所有变量均应设定其初值,而且变量的初值不应依靠编译程序自动设定。错误返回值调用方法后,应检查errno或方法返回值,以确定操作是否完成。若返回错误,返回对应的错误编码。内存释放当原先分配的内存不在需要时,应将其释放。类及方法注释在类、方法开始之前需要添加中文注释,类和方法的注释采用Java自动生成的注释格式,即输入/**回车后生成的注释格式。类注释【格式】/***类功能说明*类修改者修改日期*修改说明*Title:ZDK*Description:南华中天J2EE运行支撑及快速开发平台*Copyright:Copyright(c)2006*<pany:重庆南华中天信息技术有限公司****@author类创建者名字创建日期****@version版本号*/函数注释【格式】/***函数功能说明*创建者名字创建日期*修改者名字修改日期*修改内容****@param参数名称参数类型参数说明****@return返回值类型返回值说明*/循环语句和判断语句前必须注释。特殊变量声明时需要注释。程序段注释【格式】如果做过修改需加上修改者和日期//修改者修改日期说明或者/***修改者修改日期*说明*/变量或属性注释【格式】//说明或者/***说明*/代码格式格式缩进用分层缩进的写法显示嵌套结构的层次;巢串式陈述句应比外层陈述句内缩四格。【范例】.*;.*;;.*;.*;/***类功能说明*类修改者修改日期*修改说明*Title:ZDK*Description:南华中天J2EE运行支撑及快速开发平台*Copyright:Copyright(c)2006*<pany:重庆南华中天信息技术有限公司****@author类创建