java代码规范（一）

注释

1.      描述

注释可以生成java doc注释。

2.      类的注释

格式规范：

/*******************************************************************************

 * 版权信息：XXXXX公司

 * Copyright: Copyright (c) 2012 XXXXX公司,Inc.All Rights Reserved.

 *

 * BidPlanStructForm.java Created on 2012-12-16 下午05:53:16

 * Author: <a href=mailto:XXX@xxx.cn>XXX</a>

 * @Title: BidPlanStructForm.java

 * @Package com.cepri.structData.webc

 * Description:

 * Version: 1.0

 ******************************************************************************/

上面注释可以根据eclipse自动生成

选菜单
windows-->preference
Java-->Code Style-->Code Templates
code-->new Java files

然后点击编辑，插入下面内容：

${filecomment}

${package_declaration}

/*******************************************************************************

 * 版权信息：有限公司

 * Copyright: Copyright (c) 2007 XXXXX公司,Inc.All Rights Reserved.

 *

 * BidPlanStructForm.java Created on ${date}

 * Author: <a href=mailto:XX@CC.com>XX</a>

 * @Title: ${file_name}

 * @Package ${package_name}

 * Description:

 * Version: 1.0

 ******************************************************************************/

${typecomment}

${type_declaration}

3.      函数/方法的注释

l         函数外部注释

/**

        *

        * @Title: forInsertNotice

        * @Description: 招标公告的展现页面

        * @param @param context

        * @return void

        * @user <a href=mailto:XX@cc.cn>XX</a>

        * @throws

        */

自动生成如下：

选菜单
windows-->preference
Java-->Code Style-->Code Templates
Comments-->Methods

然后点击编辑，插入格式如下：

/**

 * 概述：

 * @Title: ${enclosing_method}

 * ${tags}

 * ${return_type}

 * @user <a href=mailto:XX@cc.com>XX</a>

 */

l         函数内部注释：

内部注释以“//”开始，

if语句、for循环等注释写在if开始的上面，

else则写在下面

如：

//注释：-----

       if(a == b){

          

       }else{

       //注释：-----

          

    }

4.      变量/常量的注释

变量注释应当表达清楚，注释格式如下：

/**可用性显示隐藏控制**/

5.      静态块的注释

静态块注释一般为加载内容，应描述什么时候加载已经加载的内容。

 

程序版式

1.      函数行数控制

函数应当尽量控制在200行以内，行数过多应该提取出共通的方法。

2.      对齐/空格

l         代码应当工整对齐，以tab和4个空格缩进。使人看到代码一目了然。

l         If语句应写成如下格式：

If( a == b){

      

}else{

      

}

l         运算符合、特殊符合应当左右各空一格。如： a = c + b; 而不应该写成a=c+b;

 

 

命名规范

1.      变量

变量声明以驼峰命名法命名，变量应尽量能描述清楚变量的作用。

如：String userName = null;

2.      常量

常量声明以全大写字母声明。

3.      类

类的命名首字母应当大写。

4.      函数/方法

函数以驼峰命名法命名。最好以一个动词和一个名词来命名。

如：public String getUserName(String userId){} （这样命名可以很清楚的知道函数所表达的意思）