JAVA开发编码规范1.2(2)

江苏亿科达科技发展有限公司

功能块结束：}//end if...userName is null?

循环快结束：}//end for...every user in userList 不要在程序中出现不必要的括号，但有时为了增加可读性和便于理解，当用括号限定相应项。

If，for，while 语句只有单句时，如果该句可能引起阅读混淆，需要用\和\括起来，否则可以省略。

三、注释规范

3.1 基本原则

基本原则：注释应该增加代码的清晰度。代码注释的目的是要使代码更易于被其他开发人员等理解。

注释信息不仅要包括代码的功能，还应给出原因。

除变量定义等较短语句的注释可用行尾注释外，其他注释当避免使用行尾注释。

3.2 文件注释

在每个文件、包的头部都应该包含该文件的功能、作用、作者、版权以及创建、修改记录等。并在其中使用版本仓库标记自动跟踪版本变化及修改记录等信息。注意是标准的C-Style/*...*/ 注释而不是/* ...*/ 形式的JavaDoc 注释，在ECLIPS中使用CODE TEMPLATES会自动添加，如下。

/*

* @(#) Test1.java

* Created Date: Sep 11, 2008 * *

* This software is the confidential and proprietary information of * Jiangsu Ecode Co., Ltd. (\ * disclose such Confidential Information and shall use it only in accordance

* with the terms of the license agreement you entered into with * Jiangsu Ecode Co., Ltd. */

* Copyright (c) Jiangsu Ecode Co., Ltd

6/18

江苏亿科达科技发展有限公司

3.3 Java Doc 注释

对类、方法、变量等的注释需要符合JavaDoc 规范，对每个类、方法都应详细说明其功能、条件、参数等，并使用良好的HTML 标记格式化注释，以使生成的JavaDoc易阅读和理解。

类注释中当包含版本和作者信息，使用版本仓库的标记自动跟踪版本变化和修改记 录，如下。

/**

* 用于示例的类 *

* @author * @version $Rev$

* $Id: Test1.java,v 1.2 2008/09/17 02:25:08 cvsroot Exp $ */

public class Test1 { }

private static final Logger logger = Logger.getLogger(Test1.class); /**

*一个测试的方法

*@param userid 用户编号

*@return 返回用户信息对象，若无该用户信息，则返回null */

private UserInfo getStrings(Integer userid) { }

……………

return userInfo;

3.4 失效代码注释

由/*...*/界定，标准的C-Style 的注释。专用于注释已失效的代码。

/*username = \

password = \ currentCar = \ logined = false;

attributes = new HashMap();

attributes.put(\

失效注释快捷键是Ctrl+Shift+/ ，取消注释是Ctrl+Shift+\\

7/18

江苏亿科达科技发展有限公司

3.5 代码细节注释

由// 界定，专用于注释代码细节，即使有多行注释也仍然使用//，以便与用/**/注 释的失效代码分开除了私有变量外，不推荐使用行末注释。

//设置CarBean

for(int i=0; i < 20; i++) { }

//首先需要生成实例

CarBean bean = new CarBean(); bean.setBaseprice(11); bean.setDescription(\); bean.setName(\); cdao.save(bean);

3.6 注释的格式

? ? ? ? ? ? ?

注释中的第一个句子要以（英文）句号、问号或者感叹号结束。Javadoc 生成工具会将注释中的第一个句子放在方法汇总表和索引中。

为了在JavaDoc 和IDE 中能快速链接跳转到相关联的类与方法，尽量多的使用@see xxx.MyClass，@see xx.MyClass#find(String)。

Class 必须以@author 作者名声明作者，不需要声明手工指定@version 与@date，由版本管理系统保留此信息。

如果注释中有超过一个段落，用

分隔。

示例代码以

标识(java keyword, class/method/field/argument 名，Constants) 以包裹。 标识在第一次出现时以{@linkxxx.Myclass}注解以便JavaDoc 与IDE 中可以链接。 …… 此处隐藏：297字，全部文档内容请下载后查看。喜欢就下载吧 ……