JAVA 语言编程规范

《JAVA 语言编程规范》由会员上传分享，免费在线阅读，更多相关内容在教育资源-天天文库。

1、杭州珍诚医药网络有限公司——JAVA编码规范内容目录一排版规范2二注释规范3三命名规范5四编码规范6五规则建议7（一）规则7（二）建议8一排版规范1程序块要采用缩进风格编写，缩进的空格数为4个，对齐只使用空格键，不使用TAB键2分界符（如大括号‘{’和‘}’），左分界符应跟随在引用语句之后，右分界符应独自一行并且与引用它们的语句左对齐；for(...){...//programcode}if(...){...//programcode}voidexample_fun(void){...//programcode}3较长的语句、

2、表达式或参数（>80字符）要分成多行书写，长表达式要在低优先级操作符处划分新行，操作符放在新行之首，划分出的新行要进行适当的缩进，使排版整齐，语句可读；if(filename!=null&&newFile(logPath+filename).length()

3、,intbufferNum)4不允许把多个短语句写在一行中，即一行只写一条语句；LogFilenamenow=null;LogFilenamethat=null;5if,for,do,while,case,switch,default等语句自占一行，且if,for,do,while等语句的执行语句无论多少都要加括号{}if(writeToFile){writeFileThread.interrupt();}6相对独立的程序块之间、变量说明之后必须加空行if(log.getLevel()

4、evel()){return;}LogWriterwriter;intindex;7在两个以上的关键字、变量、常量进行对等操作时，它们之间的操作符之前、之后或者前后要加空格；进行非对等操作时，如果是关系密切的立即操作符（如.），后不应加空格；ñ逗号、分号只在后面加空格inta,b,c;ñ比较操作符,赋值操作符"="、"+="，算术操作符"+"、"%"，逻辑操作符"&&"、"&"，位域操作符"<<"、"^"等双目操作符的前后加空格if(current_time>=MAX_TIME_VALUE)a=b+c;a*=2;a=b^2;ñ

5、"!"、"~"、"++"、"--"、"&"（地址运算符）等单目操作符前后不加空格flag=!isEmpty;//非操作"!"与内容之间i++;//"++","--"与内容之间ñ"."前后不加空格p.id=pid;//"."前后不加空格ñif、for、while、switch等与后面的括号间应加空格，使if等关键字更为突出、明显if(a>=b&&c>d)二注释规范1包的注释写入一名为package.html的HTML格式说明文件放入当前路径,例如：com/zcnet/msg/relay/comm/package.html2文件注

6、释：文件注释写入文件头部，包名之前的位置/**注释内容*/packagecom.zcnet.msg.relay.comm;3文件注释内容：版权说明、描述信息、生成日期、修改历史/**文件名：[文件名]*版权：〈版权〉*描述：〈描述〉*修改人：〈修改人〉*修改时间：YYYY-MM-DD*修改单号：〈修改单号〉*修改内容：〈修改内容〉*/4类和接口的注释：该注释放在package关键字之后，class或者interface关键字之前packagecom.zcnet.msg.relay.comm;/***注释内容*/publiccl

7、assCommManager5类和接口的注释内容：类的注释主要是一句话功能简述、功能详细描述/***〈一句话功能简述〉*〈功能详细描述〉*@author[作者]*@version[版本号,YYYY-MM-DD]*@see[相关类/方法]*@since[产品/模块版本]*@deprecated*/6类属性、公有和保护方法注释：写在类属性、公有和保护方法上面/***注释内容*/privateStringlogType;/***注释内容*/publicvoidwrite()7成员变量注释内容：成员变量的意义、目的、功能，可能被用到的

8、地方8公有和保护方法注释内容：列出方法的一句话功能简述、功能详细描述、输入参数、输出参数、返回值、违例/***〈一句话功能简述〉*〈功能详细描述〉*@param[参数1][参数1说明]*@param[参数2][参数2说明]*@return[返回类型说明]*@exception