博客
关于我
强烈建议你试试无所不能的chatGPT,快点击我
Java魔法堂:注释和注释模板
阅读量:5837 次
发布时间:2019-06-18

本文共 1551 字,大约阅读时间需要 5 分钟。

一、注释                                  

  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节点(构造函数注释标签)

/** * 

Title:

*

Description:

* ${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 下可导入导出注释模板。

 尊重原创,转载请注明来自:  ^_^肥仔John

如果您觉得本文的内容有趣就扫一下吧!捐赠互勉!

本文转自^_^肥仔John博客园博客,原文链接:http://www.cnblogs.com/fsjohnhuang/p/3988883.html,如需转载请自行联系原作者

你可能感兴趣的文章
Hadoop生态圈-Kafka常用命令总结
查看>>
浮点数内存如何存储的
查看>>
EventSystem
查看>>
用WINSOCK API实现同步非阻塞方式的网络通讯
查看>>
玩一玩博客,嘿嘿
查看>>
JsonCpp 的使用
查看>>
问题账户需求分析
查看>>
32、SpringBoot-整合Dubbo
查看>>
spring两大核心对象IOC和AOP(新手理解)
查看>>
hp 服务器通过串口重定向功能的使用
查看>>
MongoDB CookBook读书笔记之导入导出
查看>>
shell如何快速锁定所有账号
查看>>
HTML 5实现的手机摇一摇
查看>>
此博客不再发表对自己私事的看法
查看>>
导致Asp.Net站点重启的10个原因
查看>>
【PMP】Head First PMP 学习笔记 第一章 引言
查看>>
抓住云机遇编排工作 搞定复杂IT工作流
查看>>
MYSQL的longtext字段能放多少数据?
查看>>
MTK 平台上如何给 camera 添加一种 preview size
查看>>
云计算最大难处
查看>>