myeclipse中java文件头注释格式设置

myeclipse中java文件头注释格式设置  



windows->preferences->java->Code Templates->comments->Type->edit 
Eclipse注释规范模版总结
新建类文件
/**
 * @ClassName:     ${file_name}
 * @Description:   ${todo}(用一句话描述该文件做什么) 
 * 
 * @author         ${user}
 * @version        V1.0  
 * @Date           ${date} ${time} 
 */
方法
/** 
 * @Title:        ${enclosing_method} 
 * @Description:  ${todo}(这里用一句话描述这个方法的作用) 
 * @param:        ${tags}    
 * @return:       ${return_type}    
 * @throws 
 * @author        ${user}
 * @Date          ${date} ${time} 
 */
输入设置模板: 
/**      
* ${file_name} Create on ${date}     
*      
* Copyright (c) ${date} by taotaosoft      
*      
* @author <a href="cqcn@gmail.com">cqcn</a>     
* @version 1.0 
*     
 
 Eclipse注释规范模版总结
1、  具体操作
(1)在eclipse中,打开Window->Preference->Java->Code Style->Code Template
(2)然后展开Comments节点就是所有需设置注释的元素,参照2注释规范对应设置即可
2、  注释规范
(1)文件(Files)注释标签
/**
 * FileName:     ${file_name}
 * @Description: ${todo}(用一句话描述该文件做什么)
* All rights Reserved, Designed By ALIBABA.COM
 * Copyright:    Copyright(C) 1998-2015
 * Company       ALIBABA
 * @author:    名字
 * @version    V1.0 
 * Createdate:         ${date} ${time}
 *
 * Modification  History:
 * Date         Author        Version        Discription
 * -----------------------------------------------------------------------------------
 * ${date}       CQCN         1.0             1.0
 * Why & What is modified: <修改原因描述>
 */
 
(2)类型(Types)注释标签(类的注释):
 /**
 * @ClassName:     ${type_name}
 * @Description:${todo}(这里用一句话描述这个类的作用)
 * @author:    Android_Robot
 * @date:        ${date} ${time}
 *
 * ${tags}
 */
 
(3)字段(Fields)注释标签:
 /**  
 * @Fields ${field} : ${todo}(用一句话描述这个变量表示什么)   
 */  
  
(4)构造函数标签:
 /**
 * @Title:        ${enclosing_type}
 * @Description:    ${todo}(这里用一句话描述这个方法的作用)
 * @param:    ${tags}
 * @throws
 */
 
(5)方法(Methods)标签:
/**
 * @Title: ${enclosing_method}
 * @Description: ${todo}(这里用一句话描述这个方法的作用)
 * @param: ${tags}   
 * @return: ${return_type}   
 * @throws
 */
 
(6)覆盖方法(Overriding Methods)标签:
 /**
 * <p>Title: ${enclosing_method}</p>
 * <p>Description: </p>
 * ${tags}
 * ${see_to_overridden}
 */
 
(7)代表方法(Delegate Methods)标签:
/**
 * ${tags}
 * ${see_to_target}
 */
 
(8)getter方法标签:
/**
 * @Title:        ${enclosing_method} <BR>
 * @Description: please write your description <BR>
 * @return:     ${field_type} <BR>
 */
 
(9)setter方法标签:
/** 
 * @Title:  ${enclosing_method} <BR> 
 * @Description: please write your description <BR> 
 * @return: ${field_type} <BR> 
 */ 
  • 0
    点赞
  • 2
    收藏
    觉得还不错? 一键收藏
  • 6
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 6
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值