Java语言编程规范--华为01年

密级: 内部公开

DKBAXXXX-2001.12

注释规范

IIN V100R001 WEBSMAP


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

4.

文件注释:文件注释写入文件头部,包名之前的位置。

说明:注意以 /* 开始避免被 JavaDoc 收集 示例: /*

* 注释内容 */

package com.huawei.iin.websmap.comm;

5.

文件注释内容:版权说明、描述信息、生成日期、修改历史。

说明:文件名可选。

格式: /*

* 文件名:[文件名] * 版权:〈版权〉 * 描述:〈描述〉 * 修改人:〈修改人〉 * 修改时间:YYYY-MM-DD * 跟踪单号:〈跟踪单号〉 * 修改单号:〈修改单号〉 * 修改内容:〈修改内容〉 */

说明:每次修改后在文件头部写明修改信息,CheckIn的时候可以直接把蓝色字体信息粘

贴到VSS的注释上。在代码受控之前可以免去。

2005-10-15, 11:40:39

21

密级: 内部公开

DKBAXXXX-2001.12

注释规范

示例: /*

* 文件名:LogManager.java

* 版权:Copyright 2000-2001 Huawei Tech. Co. Ltd. All Rights Reserved. * 描述: WIN V200R002 WEBSMAP 通用日志系统 * 修改人: 张三 * 修改时间:2001-02-16 * 修改内容:新增 * 修改人: 李四 * 修改时间:2001-02-26 * 跟踪单号:D20103 * 修改单号:WSS368 * 修改内容:。。。。。。 * 修改人: 王五 * 修改时间:2001-03-25 * 跟踪单号:D27153 * 修改单号:WSS498 * 修改内容:。。。。。。 */

6.

类和接口的注释:该注释放在 package 关键字之后,class 或者 interface

关键字之前。

说明:方便JavaDoc收集 示例:

package com.huawei.iin.websmap.comm; /**

* 注释内容 */

public class CommManager

2005-10-15, 11:40:39

22

密级: 内部公开

DKBAXXXX-2001.12

注释规范

7.

类和接口的注释内容:类的注释主要是一句话功能简述、功能详细描

述,

说明:可根据需要列出:版本号、生成日期、作者、内容、功能、与其它类的关系等。

如果一个类存在Bug,请如实说明这些Bug。

格式:

>>闂傚倸鍊搁崐鎼佸磹閹间礁纾圭€瑰嫭鍣磋ぐ鎺戠倞妞ゆ帒顦伴弲顏堟偡濠婂啰绠绘鐐村灴婵偓闁靛牆鎳愰濠傗攽鎺抽崐鎰板磻閹惧墎妫柟顖嗗瞼鍚嬮梺鍝勭焿缂嶄線鐛崶顒夋晬闁挎繂妫岄幐鍛節閻㈤潧浠滄俊顖氾攻缁傚秴饪伴崼婵堫槰闂侀€炲苯澧い顏勫暣婵″爼宕卞Δ鈧〖缂傚倸鍊哥粔鏉懳涘Δ鈧悳濠氬锤濡や礁浜滈梺绋跨箰閻ㄧ兘骞忛搹鍦<缂備降鍨归獮鏍煙閸愯尙绠洪柕鍥ㄥ姌椤﹀绱掓潏銊ユ诞闁诡喒鏅犲畷姗€鎳犻鎸庡亝缂傚倸鍊风欢锟犲窗閺嶎厽鍋嬮柟鎯х-閺嗭箓鏌熼悜姗嗘畷闁稿﹦鍏橀幃妤呮偨閻ц婀遍弫顕€骞嗚閺€浠嬫煟濡櫣浠涢柡鍡忔櫅閳规垿顢欑喊鍗炴闂佺懓绠嶉崹纭呯亽婵炴挻鍑归崹鎶藉焵椤掑啫鐓愰柕鍥у瀵潙螖閳ь剚绂嶆ィ鍐┾拺闁告繂瀚悞璺ㄧ磼閺屻儳鐣烘鐐叉瀵噣宕奸锝嗘珫婵犵數鍋為崹鍫曟晝閳哄倸顕遍柨鐕傛嫹<<
12@gma联系客服:779662525#qq.com(#替换为@) 苏ICP备20003344号-4