当前位置 博文首页 > chinaxiaofeng8的专栏:快速给类方法加注释
1. 类的版权注释格式及设置步骤方式:?
Eclipse -> Window -> Preferences -> Java -> Code Style -> Code Templates -> Code? -> New Java files? -> Edit
/*??
* Copyright (c) 2010-2020 Founder Ltd. All Rights Reserved.??
*??
* This software is the confidential and proprietary information of??
* Founder. You shall not disclose such Confidential Information??
* and shall use it only in accordance with the terms of the agreements??
* you entered into with Founder.??
*??
*/???
${filecomment}??
${package_declaration}??
??
${typecomment}??
${type_declaration}?
2.类的注释格式及设置步骤如下:?
Eclipse -> Window -> Preferences -> Java -> Code Style -> Code Templates -> Comments -> Types -> Edit
/**??
* This class is used for ...??
* @author jseven1989?
* @version??
*?????? 1.0, ${date} ${time}??
*/???
3.类的方法注释格式设置方式:
Eclipse -> Window -> Preferences -> Java -> Code Style -> Code Templates -> Comments -> Methods -> Edit?
/**?
* ${tags}?
* @author jseven1989?
*/??
其他说明
---------------------------
JAVA注释具体实现
1、源文件注释?
源文件注释采用 /** …… */,在每个源文件的头部要有必要的注释信息,包括:文件名;文件编号;版本号;作者;创建时间;文件描述包括本文件历史修改记录等。中文注释模版:?
/**?
* 文 件 名 :?
??? * CopyRright (c) 2008-xxxx:?
* 文件编号:?
* 创 建 人:?
* 日??? 期:?
* 修 改 人:?
* 日?? 期:?
* 描?? 述:?
* 版 本 号:?
*/?
2、类(模块)注释:?
类(模块)注释采用 /** …… */,在每个类(模块)的头部要有必要的注释信息,包括:工程名;类(模块)编号;命名空间;类可以运行的JDK版本;版本号;作者;创建时间;类(模块)功能描述(如功能、主要算法、内部各部分之间的关系、该类与其类的关系等,必要时还要有一些如特别的软硬件要求等说明);主要函数或过程清单及本类(模块)历史修改记录等。?
英文注释模版:?
/**?
* CopyRright (c)2008-xxxx:?? <展望软件Forsoft >??????????????????????????
??? * Project:???????????????????? <项目工程名 >??????????????????????????????????????????
* Module ID:?? <(模块)类编号,可以引用系统设计中的类编号>????
??? * Comments:? <对此类的描述,可以引用系统设计中的描述>???????????????????????????????????????????
* JDK version used:????? <JDK1.6>??????????????????????????????
* Namespace:?????????? <命名空间>??????????????????????????????
* Author:??????? <作者中文名或拼音缩写>?????????????????
* Create Date:? <创建日期,格式:YYYY-MM-DD>?
* Modified By:?? <修改人中文名或拼音缩写>?????????????????????????????????????????
* Modified Date:? <修改日期,格式:YYYY-MM-DD>????????????????????????????????????
??? * Why & What is modified? <修改原因描述>????
* Version:????????????????? <版本号>???????????????????????
*/?
如果模块只进行部分少量代码的修改时,则每次修改须添加以下注释:?
//Rewriter?
//Rewrite Date:<修改日期:格式YYYY-MM-DD> Start1:?
/* 原代码内容*/?
//End1:?
将原代码内容注释掉,然后添加新代码使用以下注释:?
//Added by?
//Add date:<添加日期,格式:YYYY-MM-DD> Start2:?
//End2:?
如果模块输入输出参数或功能结构有较大修改,则每次修改必须添加以下?
注释:?
//Log ID:<Log编号,从1开始一次增加>?
//Depiction:<对此修改的描述>?
//Writer:修改者中文名?
//Rewrite Date:<模块修改日期,格式:YYYY-MM-DD>?
2、接口注释:?
接口注释采用 /** …… */,在满足类注释的基础之上,接口注释应该包含描述接口的目的、它应如何被使用以及如何不被使用,块标记部分必须注明作者和版本。在接口注释清楚的前提下对应的实现类可以不加注释。?
3、构造函数注释:?
构造函数注释采用 /** …… */,描述部分注明构造函数的作用,不一定有块标记部分。?
注释模版一:?
/**?
* 默认构造函数?
*/?
注释模版二:?
/**?
* Description :?????? 带参数构造函数,?
*?????????????????????? 初始化模式名,名称和数据源类型?
* @param schema:?? 模式名?
* @param name:?? 名称?
* @param type: 数据源类型?
*/?
4、函数注释:?
函数注释采用 /** ……*/,在每个函数或者过程的前面要有必要的注释信息,包括:函数或过程名称;功能描述;输入、输出及返回值说明;调用关系及被调用关系说明等。函数注释里面可以不出现版本号(@version)。?
注释模版一:?
/**?
? * 函 数 名 :?
? * 功能描述:?
* 输入参数:???? <按照参数定义顺序>?
*???????????? <@param后面空格后跟着参数的变量名字?
*??????????? (不是类型),空格后跟着对该参数的描述。>?
*?
* 返 回 值:? - 类型 <说明>?
*??????????? <返回为空(void)的构造函数或者函数,?
*??????????? @return可以省略; 如果返回值就是输入参数,必须 *??????????? 用与输入参数的@param相同的描述信息; 必要的时*??????????? 候注明特殊条件写的返回值。>?
* 异??? 常:<按照异常名字的字母顺序>?
* 创 建 人:?
* 日??? 期:?
* 修 改 人:?
* 日??? 期:?
*/?
注释模版二:?
/**?
* FunName:?????????? getFirstSpell?
? * Description :????? 获取汉字拼音首字母的字符串,?
*?????????????????? 被生成百家姓函数调用?
? * @param:???????? str the String是包含汉字的字符串?
? * @return String:汉字返回拼音首字母字符串;?
*????????????????? 英文字母返回对应的大写字母;?
*???????????????? 其他非简体汉字返回 '0';?
* @Author:?????? ghc?
* @Create Date: 2008-07-02?
*/?
5、方法注释:?
方法注释采用 /** …… */,对于设置 (Set 方法 ) 与获取 (Get 方法 ) 成员的方法,在成员变量已有说明的情况下,可以不加注释;普通成员方法要求说明完成什么功能,参数含义是什么且返回值什么;另外方法的创建时间必须注释清楚,为将来的维护和阅读提供宝贵线索。?
6、方法内部注释:?
控制结构,代码做了些什么以及为什么这样做,处理顺序等,特别是复杂的逻辑处理部分,要尽可能的给出详细的注释。?
????
7、 全局变量注释:?
要有较详细的注释,包括对其功能、取值范围、哪些函数或者过程存取以及存取时注意事项等的说明。?
8、局部(中间)变量注释:?
主要变量必须有注释,无特别意义的情况下可以不加注释。?
9、实参/参数注释:?
参数含义、及其它任何约束或前提条件。?
10、字段/属性注释: 字段描述,属性说明。?
11、常量:常量通常具有一定的实际意义,要定义相应说明。
12、新建类时候,生成注释:?
Window--》Preferences--》Java--》Code Style--》Code Templates--》Commonts--》Types,设置完成后在新建类时勾上Generate comments?
/**?
* @author name?
*?
*/?
13、在方法前生成注释:?
Window--》Preferences--》Java--》Code Style--》Code Templates--》Commonts--》Methods,点击EDIT,进行设置,然后再选择某个方法名,按shift+alt+j 生成注释?
/**?
? * ${enclosing_method} 方法?
? * <p>方法说明:</p>?
? * ${tags}?
? * @return ${return_type}?
? * @author name?
? * @date ${date}?
*/?
14、以相同的方式可以对get 、set方法或者其它的进行设置注释?
15、在java代码中:shift+ctrl+/ 生成注释? /**/;ctrl+/ 生成// ;在jsp页面中:shift+ctrl+/ 生成注释? <!--?? ***-->?
???? shift+alt + r->改名—>enter?
???? ctrl +1 自动生成类型?
???? alt + 上或下方向键—>将整行移上移下?
???? shift +alt+J 自动生成方法注释