专栏首页卯金刀GG【java基础】Eclipse Java注释模板设置详解以及版权声明

【java基础】Eclipse Java注释模板设置详解以及版权声明

本文转载自:https://www.cnblogs.com/lr393993507/p/5867623.html

网上的Eclipse注释模板,在这里稍稍整理一些比较常用的。

编辑注释模板的方法:Window->Preference->Java->Code Style->Code Template 然后展开Comments节点就是所有需设置注释的元素啦。现就每一个元素逐一介绍:

1.文件(Files)注释标签:

/**  
 * All rights Reserved, Designed By www.tydic.com
 * @Title:  ${file_name}   
 * @Package ${package_name}   
 * @Description:    ${todo}(用一句话描述该文件做什么)   
 * @author: 天源迪科技     
 * @date:   ${date} ${time}   
 * @version V1.0 
 * @Copyright: ${year} www.tydic.com Inc. All rights reserved. 
 * 注意:本内容仅限于深圳天源迪科信息技术股份有限公司内部传阅,禁止外泄以及用于其他的商业目
 */

2.类型(Types)注释标签(类的注释):

/**   
 * @ClassName:  ${type_name}   
 * @Description:${todo}(这里用一句话描述这个类的作用)   
 * @author: 天源迪科 
 * @date:   ${date} ${time}   
 *   
 * ${tags}  
 * @Copyright: ${year} www.tydic.com Inc. All rights reserved. 
 * 注意:本内容仅限于深圳天源迪科信息技术股份有限公司内部传阅,禁止外泄以及用于其他的商业目 
 */

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 条评论
登录 后参与评论

相关文章

  • 转载【阿里员工排查问题的工具清单,总有一款适合你】

    这是一篇来源于阿里内部技术论坛的文章,原文在阿里内部获得一致好评。作者已经把这篇文章开放到云栖社区中供外网访问。文章内容做了部分删减,主要删减掉了其中只有阿里内...

    用户5640963
  • c# 利用AForge.NET组件操作摄像头

    private FilterInfoCollection videoDevices;

    用户5640963
  • 【LeetCode-解题一 求和】

    Given an array of integers, return indices of the two numbers such that they add...

    用户5640963
  • EMNLP 2019 | 常识信息增强的事件表示学习

    事件是现实世界中一种重要的知识,学习有效的事件表示可以提升脚本事件预测等许多下游任务的效果。事件是对客观事实的表达,然而客观事件的发生会对人类的主观情感产生影响...

    AI科技评论
  • 哈工大SCIR Lab | EMNLP 2019 常识信息增强的事件表示学习

    论文名称:Event Representation Learning Enhanced with External Commonsense Knowledge

    zenRRan
  • 一份超详细的「iOS 10 UI Kit」使用手册(附源文件)

    前言 Apple 早先于 WWDC 2016 发表了 iOS 10,而 Sketch 也推出了第 39 版,其中包含了一系列令人兴奋的新功能;我认为这对很多有意...

    前朝楚水
  • SAP CRM系统订单模型的设计与实现

    版权声明:本文为博主汪子熙原创文章,未经博主允许不得转载。 https://jerry.blog....

    Jerry Wang
  • 第二节 - MYSQL环境配置

    剽悍一小兔
  • 基于图卷积神经网络的城市轨道交通流量预测

    《Predicting Station-Level Short-Term Passenger Flow in a Citywide Metro Network ...

    深度学习与交通大数据
  • 事件流处理框架NEsper for .NET

    复合事件处理(Complex Event Processing)介绍提到了开源的Esper,NEsper 是一个事件流处理(Event Stream Proce...

    张善友

扫码关注云+社区

领取腾讯云代金券