Java魔法堂:注释和注释模板
时间:2022-04-22
本文章向大家介绍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 下可导入导出注释模板。
- 抓住“新代码”的影子 —— 基于GoAhead系列网络摄像头多个漏洞分析
- Python 用OPEN读文件报错 ,路径以及r
- python 如何设置多线程
- R语言读CSV、txt文件方式以及read.table read.csv 和readr(大数据读取包)
- python 多进程设置 整理版本1
- 11g Dataguard中的snapshot standby特性(r8笔记第49天)
- 物化视图刷新结合ADG的尝试 (r8笔记第47天)
- 关于CPU使用率高的awr分析(r8笔记第46天)
- 图形工具和命令行的博弈-swingbench配置(r8笔记第63天)
- 手把手教你用LDA特征选择
- 一个关于执行计划的小问题测试(r8笔记第60天)
- 【Go 语言社区】www.golangweb.com通过工信部审核,正式挂牌社区域名
- golang 算法课程 正式开课--第一季 第1节
- 在 Mac OS X 装不上 TensorFlow?看了这篇就会装
- java教程
- Java快速入门
- Java 开发环境配置
- Java基本语法
- Java 对象和类
- Java 基本数据类型
- Java 变量类型
- Java 修饰符
- Java 运算符
- Java 循环结构
- Java 分支结构
- Java Number类
- Java Character类
- Java String类
- Java StringBuffer和StringBuilder类
- Java 数组
- Java 日期时间
- Java 正则表达式
- Java 方法
- Java 流(Stream)、文件(File)和IO
- Java 异常处理
- Java 继承
- Java 重写(Override)与重载(Overload)
- Java 多态
- Java 抽象类
- Java 封装
- Java 接口
- Java 包(package)
- Java 数据结构
- Java 集合框架
- Java 泛型
- Java 序列化
- Java 网络编程
- Java 发送邮件
- Java 多线程编程
- Java Applet基础
- Java 文档注释