Eclipse中java⽂件头注释格式设置Eclipse中java⽂件头注释格式设置
Eclipse中java⽂件头注释格式设置
windows->preferences->java->Code Templates->comments->Type->edit
Eclipse注释规范模版总结
新建类⽂件
/**
* @ClassName:    ${file_name}
* @Description:  ${todo}(⽤⼀句话描述该⽂件做什么)
*
*          ${user}
*        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="xiuzhong.li@gmail">Jerryli</a>
* @version 1.0
*
*/
注意选择⾃动添加注释，养成⼀个规范的习惯是最好的。
选菜单
windows-->preference  --> Java-->Code Style-->Code Templates  --> code-->new Java files
选中点编辑
${filecomment}
${package_declaration}
/**
* @author 作者姓名  E-mail: email地址
* @version 创建时间：${date} ${time}
* 类说明
*/
${typecomment}
${type_declaration}
Eclipse注释规范模版总结
1、  具体操作
(1)在eclipse中，打开Window->Preference->Java->Code Style->Code Template
(2)然后展开Comments节点就是所有需设置注释的元素，参照2注释规范对应设置即可2、  注释规范
(1)⽂件(Files)注释标签eclipse怎么打开已有的java文件
/**
* FileName:    ${file_name}
* @Description: ${todo}(⽤⼀句话描述该⽂件做什么)
* All rights Reserved, Designed By ZTE-ITS
* Copyright:    Copyright(C) 2010-2011
* Company      ZTE-ITS WuXi LTD.
* @author:    名字
* @version    V1.0
* Createdate:        ${date} ${time}
*
* Modification  History:
* Date        Author        Version        Discription
* ----------------------------------------------------------------------------------- * ${date}      wu.zh          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>
*/

版权声明：本站内容均来自互联网，仅供演示用，请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198，我们将在24小时内删除。