手机版
你好,游客 登录 注册
背景:
阅读新闻

华为Java编程规范 DOC

[日期:2017-03-24] 来源:Linux社区  作者:Linux [字体: ]

1   Java  编程规范

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字符)要分成多行书写,长表达式要在低优先级操作符处划分新行,操作符放在新行之首,划分出的新行要进行适当的缩进,使排版整齐,语句可读。(1.42+)

示例:

        if (logger.isDebugEnabled())

        {

            logger.debug("Session destroyed,call-id"

                    + event.getSession().getCallId());

        }

   

       

规则4      不允许把多个短语句写在一行中,即一行只写一条语句(1.42+)

      说明:阅读代码更加清晰

      示例:如下例子不符合规范。

      Object o = new Object(); Object b = null;

规则5      if, for, do, while, case, switch, default 等语句自占一行,且if, for, do, while,switch等语句的执行语句无论多少都要加括号{},case 的执行语句中如果定义变量必须加括号{}。(1.42+)

      说明:阅读代码更加清晰,减少错误产生

      示例:

      if (a>b)

{

doStart();

}

    case x:

{

int i = 9;

}

   

规则6      相对独立的程序块之间、变量说明之后必须加空行。 (1.42+)

说明:阅读代码更加清晰

示例:

if(a > b)

{

doStart();

}

//此处是空行

return;

规则7      在两个以上的关键字、变量、常量进行对等操作时,它们之间的操作符之前、之后或者前后要加空格;进行非对等操作时,如果是关系密切的立即操作符(如.),后不应加空格。(1.42+)

说明:阅读代码更加清晰

示例:

if (a == b)

{

objectA.doStart();

}

a *= 2;

1.1.2     建议

建议1      类属性和类方法不要交叉放置,不同存取范围的属性或者方法也尽量不要交叉放置。(1.42+)

格式:

类定义

{

    类的公有属性定义

    类的保护属性定义

    类的私有属性定义

    类的公有方法定义

    类的保护方法定义

    类的私有方法定义

}

建议2      修饰词按照指定顺序书写:[访问权限][static][final] 。(1.42+)

      示例:

      public static final String str = “abc”;

1.2   注释

1.2.1     规则

规则1      源程序注释量必须在30%以上。(1.42+)

说明:由于每个文件的代码注释不一定都可以达到30%,建议以一个系统内部模块作为单位进行检查

     

规则2      包的注释:写入一个名为 package.html 的HTML格式的说明文件放入包所在路径。包的注释内容:简述本包的作用、详细描述本包的内容、产品模块名称和版本、公司版权。(1.42+)

说明:方便JavaDoc收集,方便对包的了解

示例:

com/huawei/iin/websmap/comm/package.html

<html>

<body>

<p>一句话简述。

<p>详细描述。

<p>产品模块名称和版本

<br>公司版权信息

</body>

</html>

示例:

<html>

<body>

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

<p>详细描述。。。。。。。。

<p>IIN V100R001 WEBSMAP

<br>(C) 版权所有 2000-2001 华为技术有限公司

</body>

</html>

Word文档可以到Linux公社资源站下载:

------------------------------------------分割线------------------------------------------

免费下载地址在 http://linux.linuxidc.com/

用户名与密码都是www.linuxidc.com

具体下载目录在 /2017年资料/3月/24日/华为Java编程规范 DOC/

下载方法见 http://www.linuxidc.com/Linux/2013-07/87684.htm

------------------------------------------分割线------------------------------------------

本文永久更新链接地址http://www.linuxidc.com/Linux/2017-03/142132.htm

linux
相关资讯       华为Java编程规范  Java编程规范 
本文评论   查看全部评论 (0)
表情: 表情 姓名: 字数

       

评论声明
  • 尊重网上道德,遵守中华人民共和国的各项有关法律法规
  • 承担一切因您的行为而直接或间接导致的民事或刑事法律责任
  • 本站管理人员有权保留或删除其管辖留言中的任意内容
  • 本站有权在网站内转载或引用您的评论
  • 参与本评论即表明您已经阅读并接受上述条款