JAVA开发规范.doc

JAVA开发规范编码规范对于开发人员绝对重要,我总结了下有以下原因:-一个软件的生命周期中,80%的花费在于维护-几乎没有任何一个软件,在其整个生命周期中,均由最初的开发人员来维护-编码规范可以改善软件的可读性,可以让程序员尽快而彻底地理解新的代码-如果你将源码作为产品发布,就需要确任它是否被很好的打包并且清晰无误为了执行规范,每个软件开发人员必须一致遵守开发规范。我列举了一些较为常用的注意事项,希望大家仔细看下,如果有不全的请与我联系。·写过的代码必须格式化 开发的人员越来越多,在SVN合并分支时由于代码格式化问题也会存在冲突。公司有统一的代码格式化文件,每个开发人员必须将这份文件引入到自己的ECLIPSE或IDEA中。N个人开发出来的东西能不能像一个人的风格就靠这个文件了!(ECLIPSE快捷键Ctrl+Shift+F,记得每次关闭文件前都执行以下,如果是修改文件的话只需要选中自己修改过的代码格式化即可)·将多余的import去掉 没引用即不需要使用,不需要使用即不需要import。为阅读方便不可以使用通配符。如:.*//不推荐·接口、类、变/常量、参数名,命名是否规范 命名规范以JAVA驼峰字为准则。类型范例说明包命名(.,(Classes)ExampleDaoImpl每个单词的第一个字为大写接口命名(Interface)ExampleDao每个单词的第一个字为大写方法命名(Methods)createExample()除第一个单词的第一个字母为小写外,其余单词的第一个字母均为大写变量命名(Variables)intage;除第一个单词的第一个字母小写外,其余单词的第一个字母均为大写,变量命名要尽可能的有意义。常量命名(Constants)staticfinalintCOUNT=500;字母大写,单词见用_分隔 当编写类和接口时,应遵循以下格式规则: -在方法名与其参数列表之前的左括号"("间不要有空格-左大括号"{"位于声明语句同行的末尾-右大括号"}"另起一行,与相应的声明语句对齐,除非是一个空语句,"}"应紧跟在"{"之后 如: classSampleextendsObject{     intivar1;     intivar2;      Sample(inti,intj){         ivar1=i;         ivar2=j;     }      intemptyMethod(){}  }·是否定义了多余的变量、方法等 将代码中没有引用到的变量、方法直接干掉。·检查public、protected、private、static等是否合理 这个对于接口封装有很大的作用。·if、for、while、switch语句块都必须使用{} 虽然JAVA语句块有时可以不使用{},但从代码可读性和可维护性出发必须使用{},switch必须提供缺省的default语句。避免以后维护时其他人改错了。·for/do/while/if/else等语句块不应该出现无意义空语句块。·对于条件判断语句,始终采用常量在前,变量在后的写法,可以避免空指针错误的出现 代码中不允许出现类似于“Y”.equals(arg)等写法,遇到此类情况可以将其提取出