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

 尊重原创,转载请注明来自:http://www.cnblogs.com/fsjohnhuang/p/3988883.html  ^_^肥仔John

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

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


相关文章
|
Java 编译器
课时7:Java程序基本概念(注释)
课时7介绍了Java程序中的注释。编程语言有其语法和语义,注释有助于理解代码需求,防止断档。Java支持三类注释:单行(//)、多行(/* */)和文档注释(/** */)。注释不会被编译器编译。范例中展示了如何在代码中使用注释,并强调了注释对项目文档管理的重要性。
418 3
|
算法 Java API
Java 方法注释:规范、实用和高质量的写法
本文深入探讨了如何编写高质量的 Java 方法注释
1200 11
Java 中的注释
1. 单行注释:// 2. 多行注释:/* */ 3. 文档注释::/** **/
|
搜索推荐 Java 数据库连接
Java|在 IDEA 里自动生成 MyBatis 模板代码
基于 MyBatis 开发的项目,新增数据库表以后,总是需要编写对应的 Entity、Mapper 和 Service 等等 Class 的代码,这些都是重复的工作,我们可以想一些办法来自动生成这些代码。
709 6
|
Java 测试技术 程序员
💡Java 零基础 | 深入理解注释的重要性与应用
【10月更文挑战第10天】本文收录于「滚雪球学Java」专栏,专业攻坚指数级提升,希望能够助你一臂之力,帮你早日登顶实现财富自由🚀;同时,欢迎大家关注&&收藏&&订阅!持续更新中,up!up!up!!
523 5
|
算法 Java Linux
java制作海报四:java BufferedImage 转 InputStream 上传至OSS。png 图片合成到模板(另一个图片)上时,透明部分变成了黑色
这篇文章主要介绍了如何将Java中的BufferedImage对象转换为InputStream以上传至OSS,并解决了png图片合成时透明部分变黑的问题。
1218 1
|
小程序
java--微信小程序发送模板消息
java--微信小程序发送模板消息
818 0
|
Java
Java PDF模板生成PDF
Java PDF模板生成PDF
532 2
|
Java API 开发者
Java 注释规范
Java中的注释规范包括单行注释(`//`)、多行注释(`/* ... */`)和文档注释(`/** ... */`)。单行注释适用于简短说明,多行注释用于较长描述,文档注释则专为自动生成API文档设计。注释应清晰明了、及时更新,避免冗余,并详细说明参数和返回值。遵循这些规范有助于提高代码的可读性和可维护性。
1359 5
|
Java Apache Maven
Java中使用poi+poi-tl实现根据模板导出word文档
这个过程不仅简化了文档生成的工作,而且保证了生成文档的一致性与准确性,特别适合于那些需要生成大量文档的自动化场景。通过以上步骤,Java开发人员可以实现高效、可靠的Word文档导出功能。
4773 0