华为java编程规范

华为java编程规范

ID:14963804

大小:217.50 KB

页数:19页

时间:2018-07-31

华为java编程规范_第1页
华为java编程规范_第2页
华为java编程规范_第3页
华为java编程规范_第4页
华为java编程规范_第5页
资源描述:

《华为java编程规范》由会员上传分享,免费在线阅读,更多相关内容在行业资料-天天文库

1、密级:内部公开1Java编程规范1.1排版1.1.1规则规则1程序块要采用缩进风格编写,缩进的空格数为4个,不允许使用TAB缩进。(1.42+)说明:缩进使程序更易阅读,使用空格缩进可以适应不同操作系统与不同开发工具。规则2分界符(如大括号‘{’和‘}’)应各独占一行,同时与引用它们的语句左对齐。在函数体的开始、类和接口的定义、以及if、for、do、while、switch、case语句中的程序或者static、,synchronized等语句块中都要采用如上的缩进方式。(1.42+)示例:if(a>b){doStart();}规则3较长的语句、表达式或参数(>80字符)要分成多行书写,长

2、表达式要在低优先级操作符处划分新行,操作符放在新行之首,划分出的新行要进行适当的缩进,使排版整齐,语句可读。(1.42+)示例:if(logger.isDebugEnabled()){logger.debug("Sessiondestroyed,call-id"+event.getSession().getCallId());}规则4不允许把多个短语句写在一行中,即一行只写一条语句(1.42+)说明:阅读代码更加清晰示例:如下例子不符合规范。Objecto=newObject();Objectb=null;规则5if,for,do,while,case,switch,default等语句自占

3、一行,且if,for,do,while,switch等语句的执行语句无论多少都要加括号{},case的执行语句中如果定义变量必须加括号{}。(1.42+)说明:阅读代码更加清晰,减少错误产生示例:if(a>b){doStart();}Page19,Total19密级:内部公开casex:{inti=9;}规则1相对独立的程序块之间、变量说明之后必须加空行。(1.42+)说明:阅读代码更加清晰示例:if(a>b){doStart();}//此处是空行return;规则2在两个以上的关键字、变量、常量进行对等操作时,它们之间的操作符之前、之后或者前后要加空格;进行非对等操作时,如果是关系密切的立

4、即操作符(如.),后不应加空格。(1.42+)说明:阅读代码更加清晰示例:if(a==b){objectA.doStart();}a*=2;1.1.1建议建议1类属性和类方法不要交叉放置,不同存取范围的属性或者方法也尽量不要交叉放置。(1.42+)格式:类定义{类的公有属性定义类的保护属性定义类的私有属性定义Page19,Total19密级:内部公开类的公有方法定义类的保护方法定义类的私有方法定义}建议1修饰词按照指定顺序书写:[访问权限][static][final]。(1.42+)示例:publicstaticfinalStringstr=“abc”;1.1注释1.1.1规则规则1源程序

5、注释量必须在30%以上。(1.42+)说明:由于每个文件的代码注释不一定都可以达到30%,建议以一个系统内部模块作为单位进行检查规则1包的注释:写入一个名为package.html的HTML格式的说明文件放入包所在路径。包的注释内容:简述本包的作用、详细描述本包的内容、产品模块名称和版本、公司版权。(1.42+)说明:方便JavaDoc收集,方便对包的了解示例:com/huawei/iin/websmap/comm/package.html

一句话简述。

详细描述。

产品模块名称和版本
公司版权信息示例:

6、dy>

为WEBSMAP提供通信类,上层业务使用本包的通信类与SMP-B进行通信。

详细描述。。。。。。。。

IINV100R001WEBSMAP
(C)版权所有2000-2001华为技术有限公司Page19,Total19密级:内部公开规则1类和接口的注释放在class或者interface关键字之前,import关键字之后。注释主要是一句话功能简述与功能详细描述。类注释使用“/***/”注释方式(1.42+)说明:方便JavaDoc收集,没有import可放在package之后。注释可根据需要列出:作者、内容、功能、与其它类的关系等。功能详细

7、描述部分说明该类或者接口的功能、作用、使用方法和注意事项,每次修改后增加作者和更新版本号和日期,@since表示从那个版本开始就有这个类或者接口,@deprecated表示不建议使用该类或者接口。/***〈一句话功能简述〉*〈功能详细描述〉*@author[作者](必须)*@see[相关类/方法](可选)*@since[产品/模块版本](必须)*@deprecated(可选)*/示例:packagecom.h

当前文档最多预览五页,下载文档查看全文

此文档下载收益归作者所有

当前文档最多预览五页,下载文档查看全文
温馨提示:
1. 部分包含数学公式或PPT动画的文件,查看预览时可能会显示错乱或异常,文件下载后无此问题,请放心下载。
2. 本文档由用户上传,版权归属用户,天天文库负责整理代发布。如果您对本文档版权有争议请及时联系客服。
3. 下载前请仔细阅读文档内容,确认文档内容符合您的需求后进行下载,若出现内容与标题不符可向本站投诉处理。
4. 下载文档时可能由于网络波动等原因无法下载或下载错误,付费完成后未能成功下载的用户请联系客服处理。