ICode9

精准搜索请尝试: 精确搜索
首页 > 编程语言> 文章详细

Eclipse 中设置作者日期等Java注释模板

2019-09-02 14:39:10  阅读:225  来源: 互联网

标签:gt Java Description Title Eclipse 注释 lt date 模板


  1. 设置注释模板的步骤:点击菜单栏上的Window -->Preferences–>Java–>Code Style -->Code Templates

  1. 常用的注解介绍:
@author 作者名
@date 日期
@version 版本标识
@parameter 参数及其意义
@return 返回值
@throws 异常类及抛出条件
@deprecated 引起不推荐使用的警告
@override 重写
  1. Comment详细设置
    ① Comments下的Files设置
/**  
* <p>Title: ${file_name}</p>  
* <p>Description: </p>  
* <p>Copyright: Copyright (c) 2017</p>  
* <p>Company: www.baidudu.com</p>  
* @author xianxian
* @date ${date}  
* @version 1.0  
*/  


②Types:对类进行注释

/**  
* <p>Title: ${type_name}</p>  
* <p>Description: </p>  
* @author xianxian 
* @date ${date}  
*/  

③Fields:对字段进行注释

/** 
* ${field}
*/  

④Constructors:对构造方法进行注释

/**  
* <p>Title: </p>  
* <p>Description: </p>  
* ${tags}  
*/  

⑤Methods:对方法进行注释

/**  
 * <p>Title: ${enclosing_method}</p>  
 * <p>Description: </p>  
 * ${tags}  
 */  

⑥Overriding Methods:对重写方法进行注释

/* (non-Javadoc)  
 * <p>Title: ${enclosing_method}</p>  
 * <p>Description: </p>  
 * ${tags}  
 * ${see_to_overridden}  
 */

⑦ Delegate methods:对代表方法进行注释

/**  
* ${tags}  
* ${see_to_target}  
*/

⑧Getters:对get方法进行注释

/**
 * @return the ${bare_field_name}  
 */

⑨Setters:对set方法进行注释

/**
 * @param ${param} the ${bare_field_name} to set  
 */

最后:

3. 注释模板的导出(导入不作介绍)


codetemplates.xml

<?xml version="1.0" encoding="UTF-8" standalone="no"?><templates><template autoinsert="false" context="constructorcomment_context" deleted="false" description="Comment for created constructors" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.constructorcomment" name="constructorcomment">/**  
* &lt;p&gt;Title: &lt;/p&gt;  
* &lt;p&gt;Description: &lt;/p&gt;  
* ${tags}  
*/</template><template autoinsert="false" context="delegatecomment_context" deleted="false" description="Comment for delegate methods" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.delegatecomment" name="delegatecomment">/**
 * ${tags}
 * ${see_to_target}
 */</template><template autoinsert="false" context="filecomment_context" deleted="false" description="Comment for created Java files" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.filecomment" name="filecomment">/**  
* &lt;p&gt;Title: ${file_name}&lt;/p&gt;  
* &lt;p&gt;Description: &lt;/p&gt;  
* &lt;p&gt;Copyright: Copyright (c) 2017&lt;/p&gt;  
* &lt;p&gt;Company: www.baidudu.com&lt;/p&gt;  
* @author xianxian
* @date ${date}  
* @version 1.0  
*/  </template><template autoinsert="false" context="overridecomment_context" deleted="false" description="Comment for overriding methods" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.overridecomment" name="overridecomment">/* (non-Javadoc)  &#13;
 * &lt;p&gt;Title: ${enclosing_method}&lt;/p&gt;  &#13;
 * &lt;p&gt;Description: &lt;/p&gt;  &#13;
 * ${tags}  &#13;
 * ${see_to_overridden}  &#13;
 */</template><template autoinsert="false" context="gettercomment_context" deleted="false" description="Comment for getter method" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.gettercomment" name="gettercomment">/**
 * @return the ${bare_field_name}
 */</template><template autoinsert="false" context="fieldcomment_context" deleted="false" description="Comment for fields" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.fieldcomment" name="fieldcomment">/** 
* ${field}
*/  </template><template autoinsert="false" context="methodcomment_context" deleted="false" description="Comment for non-overriding methods" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.methodcomment" name="methodcomment">/**  
 * &lt;p&gt;Title: ${enclosing_method}&lt;/p&gt;  
 * &lt;p&gt;Description: &lt;/p&gt;  
 * ${tags}  
 */  </template><template autoinsert="true" context="settercomment_context" deleted="false" description="Comment for setter method" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.settercomment" name="settercomment">/**
 * @param ${param} the ${bare_field_name} to set
 */</template><template autoinsert="false" context="typecomment_context" deleted="false" description="Comment for created types" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.typecomment" name="typecomment">/**  
* &lt;p&gt;Title: ${type_name}&lt;/p&gt;  
* &lt;p&gt;Description: &lt;/p&gt;  
* @author xianxian 
* @date ${date}  
*/  </template></templates>
  1. Java注释模板的使用

我常用的是**直接输入/***而后按下确定键后就可以自动生成

参考链接:

百度-Eclipse中设置作者日期等Java注释模板

==================================================================

分割线

==================================================================
博主为咯学编程:父母不同意学编程,现已断绝关系;恋人不同意学编程,现已分手;亲戚不同意学编程,现已断绝来往;老板不同意学编程,现已失业三十年。。。。。。如果此博文有帮到你欢迎打赏,金额不限。。。

标签:gt,Java,Description,Title,Eclipse,注释,lt,date,模板
来源: https://blog.csdn.net/qq_36079972/article/details/100270985

本站声明: 1. iCode9 技术分享网(下文简称本站)提供的所有内容,仅供技术学习、探讨和分享;
2. 关于本站的所有留言、评论、转载及引用,纯属内容发起人的个人观点,与本站观点和立场无关;
3. 关于本站的所有言论和文字,纯属内容发起人的个人观点,与本站观点和立场无关;
4. 本站文章均是网友提供,不完全保证技术分享内容的完整性、准确性、时效性、风险性和版权归属;如您发现该文章侵犯了您的权益,可联系我们第一时间进行删除;
5. 本站为非盈利性的个人网站,所有内容不会用来进行牟利,也不会利用任何形式的广告来间接获益,纯粹是为了广大技术爱好者提供技术内容和技术思想的分享性交流网站。

专注分享技术,共同学习,共同进步。侵权联系[81616952@qq.com]

Copyright (C)ICode9.com, All Rights Reserved.

ICode9版权所有