专栏首页偏前端工程师的驿站Java魔法堂:注释和注释模板

Java魔法堂:注释和注释模板

一、注释                                  

  1. 注释类型

     [a]. 单行注释

// 单行注释
String type = "单行注释";

     [b]. 多行注释

/* 
 * 多行注释
 */
String type = "多行注释";

     [c]. 文档注释

/**
 * 文档注释
 */
public class Dummy{}

  2. 快捷键

     [a]. 添加/取消单行注释: Ctrl+/

     [b]. 添加类的文档注释: Ctrl+Shift+j

二、注释模板                                

作用:定义文件、类和方法等默认的注释格式,减少手工输入的工作量。

1. 设置注释模板的入口:点击 Window->Preference->Java->Code Style->Code Template ,然后展开 Comments节点 。

  2. Comments节点 下的元素介绍:

File节点(文件注释标签)

/**   
* @Title: ${file_name} 
* @Package ${package_name} 
* @Description: ${todo}(用一句话描述该文件做什么) 
* @author fsjohnhuang
* @date ${date} ${time} 
* @version V1.0   
*/

Types节点(类注释标签)

/** 
* @ClassName: ${type_name} 
* @Description: ${todo}(这里用一句话描述这个类的作用) 
* @author fsjohnhuang
* @date ${date} ${time} 
* 
* ${tags} 
*/

      Fields节点(字段注释标签)

/** 
* @Fields ${field} : ${todo}(用一句话描述这个变量表示什么) 
*/ 

Constructor节点(构造函数注释标签)

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

Method节点(方法注释标签)

/** 
* @Title: ${enclosing_method} 
* @Description: ${todo}(这里用一句话描述这个方法的作用) 
* @param ${tags}  参数说明 
* @return ${return_type}    返回类型 
* @throws 
*/

Overriding Methods节点(覆盖方法注释标签)

/*
* Title: ${enclosing_method}
*Description: 
* ${tags} 
* ${see_to_overridden} 
*/

 Delegate Methods节点(代理方法注释标签)

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

  getter节点(getter方法注释标签)

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

setter节点(setter方法注释标签)

/** 
* @param ${param} 要设置的 ${bare_field_name} 
*/

  3. 导入、导出注释模板

    在 Window->Preference->Java->Code Style->Code Template 下可导入导出注释模板。

本文参与腾讯云自媒体分享计划,欢迎正在阅读的你也加入,一起分享。

我来说两句

0 条评论
登录 后参与评论

相关文章

  • CSS魔法堂:重新认识Box Model、IFC、BFC和Collapsing margins

    前言                                   盒子模型作为CSS基础中的基础,曾一度以为掌握了IE和W3C标准下的块级盒子模型即可,...

    ^_^肥仔John
  • Node魔法堂:NPM入了个门

    一、前言                                NPM作为Node的模块管理和发布工具,作用与Ruby的gem、Python的pypl或...

    ^_^肥仔John
  • JS魔法堂:关于元素位置和鼠标位置的属性

    一、关于鼠标位置的属性                           1. 触发鼠标事件的区域       盒子模型中的border,padding,co...

    ^_^肥仔John
  • Python注释用法

    在Python中的注释与其他语言相比有很大的不同,但使用起来也很简单。在Python中有两种注释,一种是单行注释,一种是多行注释。单行注释适用于简短快速的注释(...

    marsggbo
  • 客户让你给代码加注释怎么办?

    作为乙方,我以前听过一些同事说客户要求给代码加注释,一开始自己不以为然,直到有一天这件事情发生在我身上:某大有可为的项目接近尾声,准备下项目前一周,PM说接到客...

    袁慎建@ThoughtWorks
  • 代码洁癖系列(四):可忽略的注释

    刚开始学编程的时候,老师就告诉我们,注释很重要,但是一直到现在,也没有人真正告诉过我要怎么写注释。还有很多人甚至干脆不写注释。所以今天想聊一下到底如何写注释。

    Jackeyzhe
  • Java-初级编码规范

    良好的编码规范和习惯会让你的代码锦上添花,同时也会大大的增加团队协作开发的效率,避免很多细节的问题,从而大大的提高你的代码的可阅读性,同时也是一个优秀开发者的必...

    老九学堂-小师弟
  • C++注释风格建议

    有个笑话,一位从不写注释的程序员在编写一段复杂的代码时,骄傲地认为这段代码只有自己和上帝知道它是干嘛的,等过了一段时间再回顾时,发现没有注释,感叹到这段代码现在...

    Dabelv
  • Vim实现批量注释的方法

    调试代码的时候,免不了要批量注释/取消代码注释,很多IDE都有快捷键将你选中的…

    白凡
  • 代码里注释写太多,会挨打吗?

    前几天,有个同行朋友在我的微信上留言,问我项目代码里注释写太多会挨打吗?顺手还给我甩了一张截图,上面密密麻麻的全是手工注释。

    闰土大叔

扫码关注云+社区

领取腾讯云代金券