华为JAVA编码规范介绍.doc

华为JAVA编码规范介绍 华为JAVA编码规范介绍 华为JAVA编码规范介绍 密级 :内部公然 DKBAX-2001.12 程序块采纳缩进风格 ,空格为 4 个. 说明 : 关于开发工具自动生成的代码能够不一致 分界符 (如大括号 { 和 }) 应各自占一行并且在同一列 ,同时与引用它们的语句左对齐 ,在方法的开始 ,类和接口的定义 ,以及 if,for,do,while,switch,case 语句都要采纳上述缩进 说明 : for( ) { //your code } 较长 (80 字符 )的语句 ,表达式和参数要分多行 ,长表达式要在低优先级操作符区分新行 ,操作符放内行首 ,新行要适合缩进 ,齐整 ,语句可读 . 说明 : if(filename != null new File(logPath+filename).length() logConfig.getFileSize()) { //your code } 一行只写一条语句说明 : LogFilename wow = null; LogFilename that = null; 5. if,for,do,switch,while,case,default 各占一行 ,它们的履行语句不论多少都要加 {} 说明 : if(writeToFile) { writeFileTerrupt(); } 相对独立的程序块 ,变量 ,说明要加空行说明 : if(log.getLevel() log.getRecord()) { return ; } //空行 1 密级 :内部公然 DKBAX-2001.12 LogWrite writer; 对齐只用空格键 ,不用 TAB 键说明 : 免得使用不一样的编写器阅读程序时 ,因 TAB 键所设置的空格数不一样而造成程序布局不齐整 ,JBuildr,UltraEdit 等编写环境 ,支持行首 TAB 代替成空格 , 应将该选项翻开 两个以上的重点字 ,变量 ,常量进行平等操作时 ,操作符以前 ,以后或前后要加空格 ,进行非平等操作时 ,假如是关系亲密的立刻操作符 ,后边不加空格 (如 .操作符 ) 说明 : 采纳这类松懈方式编写代码目的是让程序更为清楚 ,因为空格所产生的清楚性是相对的 ,因此在已经很清楚的语句中没有必需留空格 ,假如语句已足够清楚 ,则括号内侧 (即左括号后边和右括号前面 ) 不需要加空格 ,多重括号间不用加空格 ,因为 java 中括号已经是很清楚的标记了 .在长句中 ,假如需要加的空格特别多 ,那么应当保持整体清楚 ,而在局部中不加空格 ,给操作符留空格时不要连续留两个以上空格 类属性和方法不要交错搁置 ,不一样存取范围的属性和方法也不要交错搁置说明 : 类定义 :{ 类公有属性定义 ; 类保护属性定义 ; 类私有属性定义 ; 类公有方法定义 ; 类保护方法定义 ; 类私有方法定义 ; } 源程序的有效说明量一定在 30%以上 包的说明写入一个名为 package.html的 html 格式的说明文件放入目前路径 包的说明内容 :本包作用 ,详尽描绘本包内容 ,产品模块名称及版本 ,企业版本说明 : html body p一句话描绘 p详尽描绘 p产品模块 br企业版本信息 /body /html 2 密级 :内部公然 DKBAX-2001.12 文件说明 :写入文件头部 ,包名以前 文件说明内容 :版本说明 ,描绘信息 ,改正历史 ,生成日期说明 : /* 文件名 版权 描绘 改正人 改正时间 改正内容 追踪单号 改正单号 */ 类和接口说明 :放在 package说明以后 ,class或 interface 以前 类和接口说明内容 :类的说明要一句话功能描绘 ,功能详尽描绘说明 : /** * 一句话功能简述 * 功能详尽描绘 *@author *@version *@see [有关类 /方法 ] *@since [产品 /模块版本 ] *@deprecated (表示不建议使用该类或许接口 ) 类属性 ,公有和保护方法说明 :写在类属性 ,公有和保护方法上边 成员变量说明内容 :成员变量的意义 ,目的 ,功能 ,可能被用到的地方 公有和保护方法说明的内容 :方法的一句话功能描绘 ,功能详尽描绘 ,输入参数 , 输出参数 ,返回值 ,违例 说明 : /** *@param *@return *@exception /throws */ 关于方法内部用 throw 抛出的异样 ,要在方法的说明中注明 ,关于调用其余方法抛出的异样 ,选主要的在说明中说明 ,关于非 RuntimeException,即 throws 子句申明会抛出的异样 ,一定在方法的说明中注明 3 密级 :内部公然 DKBAX