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


目录
相关文章
|
Java 数据安全/隐私保护
java实现加密电话号码,有具体的加密流程注释
java实现加密电话号码,有具体的加密流程注释
20 0
|
6月前
|
Java Spring
【Java用法】Spring之@Nullable和@NotNull注释的使用
【Java用法】Spring之@Nullable和@NotNull注释的使用
75 0
|
1月前
|
Java 数据库连接 mybatis
mybatis简单案例源码详细【注释全面】——实体层(User.java)
mybatis简单案例源码详细【注释全面】——实体层(User.java)
13 0
|
1天前
|
Java 开发者
Java基础知识整理,注释、关键字、运算符
在日常的工作中,总会遇到很多大段的代码,逻辑复杂,看得人云山雾绕,这时候若能言简意赅的加上注释,会让阅读者豁然开朗,这就是注释的魅力!
34 11
|
1月前
|
Java 编译器 API
Java注释
Java注释
12 0
|
1月前
|
Java 数据库连接 mybatis
mybatis简单案例源码详细【注释全面】——Utils层(MybatisUtils.java)
mybatis简单案例源码详细【注释全面】——Utils层(MybatisUtils.java)
13 0
|
1月前
|
Java 数据库连接 mybatis
mybatis简单案例源码详细【注释全面】——测试层(UserMapperTest.java)
mybatis简单案例源码详细【注释全面】——测试层(UserMapperTest.java)
9 0
|
1月前
|
Java 数据库连接 mybatis
mybatis简单案例源码详细【注释全面】——实体层(Role.java)
mybatis简单案例源码详细【注释全面】——实体层(Role.java)
7 0
|
1月前
|
Java 程序员 编译器
Java注释
Java注释
14 0
|
1月前
|
Java 测试技术 API
滚雪球学Java(10):Java注释
【2月更文挑战第22天】🏆本文收录于「滚雪球学Java」专栏,专业攻坚指数级提升,助你一臂之力,带你早日登顶🚀,欢迎大家关注&&收藏!持续更新中,up!up!up!!
50 2