Java 语言编程规范.doc

《Java 语言编程规范.doc》由会员上传分享，免费在线阅读，更多相关内容在应用文档-天天文库。

1、Java语言编程规范目次前言.................................................................................31范围112规范性引用文件113术语和定义114排版规范124.1规则121.*程序块要采用缩进风格编写，缩进的空格数为4个。122.*分界符（如大括号‘{’和‘}’）应各独占一行并且位于同一列，同时与引用它们的语句左对齐。在函数体的开始、类和接口的定义、以及if、for、do、while、switch、case语句中的程序都要采用如上的缩进方式。123.*较长的语句、表达式

2、或参数（>80字符）要分成多行书写，长表达式要在低优先级操作符处划分新行，操作符放在新行之首，划分出的新行要进行适当的缩进，使排版整齐，语句可读。134.*不允许把多个短语句写在一行中，即一行只写一条语句135.*if,for,do,while,case,switch,default等语句自占一行，且if,for,do,while等语句的执行语句无论多少都要加括号{}。136.*相对独立的程序块之间、变量说明之后必须加空行。137.*对齐只使用空格键，不使用TAB键。148.*在两个以上的关键字、变量、常量进行对等操作时，它们之间的操作符之前、之后或者前后要加空格

3、；进行非对等操作时，如果是关系密切的立即操作符（如.），后不应加空格。144.2建议151.类属性和类方法不要交叉放置，不同存取范围的属性或者方法也尽量不要交叉放置。155注释规范165.1规则161.一般情况下，源程序有效注释量必须在30％以上。162.包的注释：包的注释写入一个名为package.html的HTML格式的说明文件放入当前路径。163.包的注释内容：简述本包的作用、详细描述本包的内容、产品模块名称和版本、公司版权。164.文件注释：文件注释写入文件头部，包名之前的位置。165.文件注释内容：版权说明、描述信息、生成日期、修改历史。176.类和接口

4、的注释：该注释放在package关键字之后，class或者interface关键字之前。187.类和接口的注释内容：类的注释主要是一句话功能简述、功能详细描述，188.类属性、公有和保护方法注释：写在类属性、公有和保护方法上面。199.成员变量注释内容：成员变量的意义、目的、功能，可能被用到的地方。1910.公有和保护方法注释内容：列出方法的一句话功能简述、功能详细描述、输入参数、输出参数、返回值、违例等。1911.对于方法内部用throw语句抛出的异常，必须在方法的注释中标明，对于所调用的其他方法所抛出的异常，选择主要的在注释中说明。对于非RuntimeExce

5、ption，即throws子句声明会抛出的异常，必须在方法的注释中标明。2012.*注释应与其描述的代码相近，对代码的注释应放在其上方或右方（对单条语句的注释）相邻位置，不可放在下面，如放于上方则需与其上面的代码用空行隔开。2013.*注释与所描述内容进行同样的缩排。2014.*将注释与其上面的代码用空行隔开。2115.*对变量的定义和分支语句（条件分支、循环语句等）必须编写注释。2116.*对于switch语句下的case语句，如果因为特殊情况需要处理完一个case后进入下一个case处理，必须在该case语句处理完、下一个case语句前加上明确的注释。2117

6、.*边写代码边注释，修改代码同时修改相应的注释，以保证注释与代码的一致性。不再有用的注释要删除。2118.*注释的内容要清楚、明了，含义准确，防止注释二义性。2119.*避免在注释中使用缩写，特别是不常用缩写。215.1建议211.*避免在一行代码或表达式的中间插入注释。222.*通过对函数或过程、变量、结构等正确的命名以及合理地组织代码的结构，使代码成为自注释的。223.*在代码的功能、意图层次上进行注释，提供有用、额外的信息。224.*在程序块的结束行右方加注释标记，以表明某程序块的结束。225.*注释应考虑程序易读及外观排版的因素，使用的语言若是中、英兼有的

7、，建议多使用中文，除非能用非常流利准确的英文表达。226.方法内的单行注释使用//。227.注释尽量使用中文注释和中文标点。方法和类描述的第一句话尽量使用简洁明了的话概括一下功能，然后加以句号。接下来的部分可以详细描述。238.顺序实现流程的说明使用1、2、3、4在每个实现步骤部分的代码前面进行注释。239.一些复杂的代码需要说明。236命名规范246.1规则241.包名采用域后缀倒置的加上自定义的包名，采用小写字母。在部门内部应该规划好包名的范围，防止产生冲突。部门内部产品使用部门的名称加上模块名称。产品线的产品使用产品的名称加上模块的名称。242.类名和接口使

8、用类意义完