《java编码规范设计(华为).doc》由会员分享,可在线阅读,更多相关《java编码规范设计(华为).doc(30页珍藏版)》请在淘文阁 - 分享文档赚钱的网站上搜索。
1、.Document number 文档编号 Confidentiality level 密级 内部公开Document version 文档版本 V1.00 Total 30 pages 共 30 页Java语言编码规范Prepared by 拟制Date日期 yyyy-mm-ddReviewed by 评审人Date日期 yyyy-mm-ddApproved by批准Date日期 yyyy-mm-ddJava编码规范Copyright Worksoft Creative Software Technology NanJing Branch , Ltd. Page 2, Total 30Rev
2、ision Record 修订记录Date日期Revision Version修订版本Sec No. 修改章节Change Description修改描述Author作者yyyy-mm-dd Vx.xxJava编码规范Copyright Worksoft Creative Software Technology NanJing Branch , Ltd. Page 3, Total 30Table of Contents 目录1. 范围 .42. 规范性引用文件 .43. 术语和定义 .44. 排版规范 .54.1. 规则 .54.2. 建议 .75. 注释规范 .85.1. 规则 .85.2
3、. 建议 .136. 命名规范 .166.1. 规则 .166.2. 建议 .177. 编码规范 .197.1. 规则 .197.2. 建议 .238. JTEST规范 .258.1. 规则 .258.2. 建议 .26Java编码规范Copyright Worksoft Creative Software Technology NanJing Branch , Ltd. Page 4, Total 301. 范围本规范规定了使用Java语言编程时排版、注释、命名、编码和 JTEST的规则和建议。本规范适用于使用Java语言编程的产品和项目。2. 规范性引用文件下列文件中的条款通过本规范的引用
4、而成为本规范的条款。凡是注日期的引用文件,其随后所有的修改单(不包括勘误的内容)或修订版均不适用于本规范,然而,鼓励根据本规范达成协议的各方研究是否可使用这些文件的最新版本。凡是不注日期的引用文件,其最新版本适用于本规范。序号 编号 名称1 公司- DKBA1040-2001.12 Java语言编程规范3. 术语和定义规则:编程时强制必须遵守的原则。建议:编程时必须加以考虑的原则。格式:对此规范格式的说明。说明:对此规范或建议进行必要的解释。示例:对此规范或建议从正、反两个方面给出例子。Java编码规范Copyright Worksoft Creative Software Technolog
5、y NanJing Branch , Ltd. Page 5, Total 304. 排版规范4.1. 规则4.1.1. *程序块要采用缩进风格编写,缩进的空格数为4个。说明:对于由开发工具自动生成的代码可以有不一致。4.1.2. *分界符(如大括号和)应各独占一行并且位于同一列,同时与引用它们的语句左对齐。在函数体的开始、类和接口的定义、以及if、for 、do、while、switch、case语句中的程序都要采用如上的缩进方式。示例:如下例子不符合规范。for (.) . / program codeif (.) . / program codevoid example_fun( voi
6、d ). / program code应如下书写:for (.) . / program codeif (.) . / program codevoid example_fun( void ). / program code4.1.3. *较长的语句、表达式或参数(80 字符)要分成多行书写,长表达式要在低优先级操作符处划分新行,操作符放在新行之首,划分出的新行要进行适当的缩进,使排版整齐,语句可读。 示例:if (filename != null a *= 2;a = b 2;(3) “!“、“、“+“、“-“、“ / 非操作“!“与内容之间i+; / “+“,“-“与内容之间(4) “.“
7、前后不加空格。p.id = pid; / “.“前后不加空格(5) if、for、while 、switch等与后面的括号间应加空格,使if等关键字更为突出、明显。if (a = b 5.1.5. 文件注释内容:版权说明、描述信息、生成日期、修改历史。说明:文件名可选。格式:/* 文件名:文件名* 版权:版权* 描述:描述* 修改人:修改人* 修改时间:YYYY-MM-DD* 修改单号:修改单号* 修改内容:修改内容*/说明:每次修改后在文件头部写明修改信息,CheckIn的时候可以直接把蓝色字体信息粘贴到VSS的注释上。在代码受控之前可以免去。示例:/* 文件名:LogManager.java* 版权:Copyright 2002-2007 Huawei Tech. Co. Ltd. All Rights Reserved. * 描述: MMSC V100R002 Relay 通用日志系统* 修改人: 张三* 修改时间:2001-02-16* 修改内容:新增* 修改人: 李四* 修改时间:2001-02-26* 修改单号:WSS368* 修改内容:。* 修改人: 王五* 修改时间:2001-03-25* 修改单号:WSS498* 修改内容:。*/
限制150内