java注释规范.docx

1、java注释规范设置注释模板的入口： Window-Preference-Java-Code Style-Code Template 然后展开Comments节点就是所有需设置注释的元素啦。现就每一个元素逐一介绍：文件(Files)注释标签：/* * Project: $project_name* Title: $file_name* Package $package_name* Description: $todo* author jeffshaw jeff_chon * date $date $time* Copyright: $year Inc. All rights reserved.

2、* version V1.0 */类(Types)注释标签（类的注释）：/* * ClassName: $type_name * Description: $todo* author jeffshaw jeff_chon * date $date $time * * $tags */字段(Fields)注释标签：/* * Fields $field : $todo*/构造函数标签：/* * Title: * Description: * $tags */方法(Constructor & Methods)标签：/* * Title: $enclosing_method * Description

3、: $todo* param $tags 设定文件 * return $return_type 返回类型 * throws */覆盖方法(Overriding Methods)标签：/* (非 Javadoc) * Title: $enclosing_method * Description: * $tags * $see_to_overridden */代表方法(Delegate Methods)标签：/* * $tags * $see_to_target */getter方法标签：/* * return $bare_field_name */setter方法标签：/* * param $p

4、aram 要设置的 $bare_field_name */简单模板例1： /* * Fields $field : $todo(用一句话描述这个变量表示什么) */ /* * return $bare_field_name */ /* * Title:$file_name * Description: 构造函数 * $tags */ /* * Title: $file_name * Package $package_name * Description: $todo(用一句话描述该文件做什么) * author jeffshaw email:jeff_chon * date $date $ti

5、me * version V1.0 */ /* * param $param 要设置的 $bare_field_name */* * author $user * * $tags */* * $tags * $see_to_target */* (非 Javadoc) * Title: $enclosing_method * Description: * $tags * $see_to_overridden */* * $tags */templa /* * Fields $field : $todo(用一句话描述这个变量表示什么) */ /* * return $bare_field_nam

6、e */ /* * Title:$file_name * Description: 构造函数 * $tags */ /* * Title: $file_name * Package $package_name * Description: $todo(用一句话描述该文件做什么) * author jeffshaw email:jeff_chon * date $date $time * version V1.0 */ /* * param $param 要设置的 $bare_field_name */* * author $user * * $tags */* * $tags * $see_t

7、o_target */* (非 Javadoc) * Title: $enclosing_method * Description: * $tags * $see_to_overridden */* * $tags */templa简单模板2： /* * 创建一个新的实例 $enclosing_type. * $tags */ /* * param $param the $bare_field_name to set */ /* * 此方法描述的是： * author: jeffwhaw email:jeff_chon * version: $date $time */ /* * $tags * $see_to_target */ /* * 文件名：$file_name * * 版本信息： * 日期：$date * Copyright Corporation $year * 版权所有 * */ /* * $bare_field_name * * return the $bare_field_name * since CodingExample Ver(编码范例查看) 1.0 */ /* (non-Javadoc) * $see_to_overridden */ template autoinsert=false context=fi