Loading [MathJax]/jax/input/TeX/config.js
前往小程序,Get更优阅读体验!
立即前往
首页
学习
活动
专区
圈层
工具
发布
首页
学习
活动
专区
圈层
工具
社区首页 >专栏 >Java魔法堂:注释和注释模板

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

作者头像
^_^肥仔John
发布于 2018-01-18 03:53:09
发布于 2018-01-18 03:53:09
2.6K00
代码可运行
举报
运行总次数:0
代码可运行

一、注释                                  

  1. 注释类型

     [a]. 单行注释

代码语言:javascript
代码运行次数:0
运行
AI代码解释
复制
// 单行注释
String type = "单行注释";

     [b]. 多行注释

代码语言:javascript
代码运行次数:0
运行
AI代码解释
复制
/* 
 * 多行注释
 */
String type = "多行注释";

     [c]. 文档注释

代码语言:javascript
代码运行次数:0
运行
AI代码解释
复制
/**
 * 文档注释
 */
public class Dummy{}

  2. 快捷键

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

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

二、注释模板                                

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

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

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

File节点(文件注释标签)

代码语言:javascript
代码运行次数:0
运行
AI代码解释
复制
/**   
* @Title: ${file_name} 
* @Package ${package_name} 
* @Description: ${todo}(用一句话描述该文件做什么) 
* @author fsjohnhuang
* @date ${date} ${time} 
* @version V1.0   
*/

Types节点(类注释标签)

代码语言:javascript
代码运行次数:0
运行
AI代码解释
复制
/** 
* @ClassName: ${type_name} 
* @Description: ${todo}(这里用一句话描述这个类的作用) 
* @author fsjohnhuang
* @date ${date} ${time} 
* 
* ${tags} 
*/

      Fields节点(字段注释标签)

代码语言:javascript
代码运行次数:0
运行
AI代码解释
复制
/** 
* @Fields ${field} : ${todo}(用一句话描述这个变量表示什么) 
*/ 

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

代码语言:javascript
代码运行次数:0
运行
AI代码解释
复制
/** 
* <p>Title: </p> 
* <p>Description: </p> 
* ${tags} 
*/

Method节点(方法注释标签)

代码语言:javascript
代码运行次数:0
运行
AI代码解释
复制
/** 
* @Title: ${enclosing_method} 
* @Description: ${todo}(这里用一句话描述这个方法的作用) 
* @param ${tags}  参数说明 
* @return ${return_type}    返回类型 
* @throws 
*/

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

代码语言:javascript
代码运行次数:0
运行
AI代码解释
复制
/*
* Title: ${enclosing_method}
*Description: 
* ${tags} 
* ${see_to_overridden} 
*/

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

代码语言:javascript
代码运行次数:0
运行
AI代码解释
复制
/** 
* ${tags} 
* ${see_to_target} 
*/ 

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

代码语言:javascript
代码运行次数:0
运行
AI代码解释
复制
/** 
* @return ${bare_field_name} 
*/

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

代码语言:javascript
代码运行次数:0
运行
AI代码解释
复制
/** 
* @param ${param} 要设置的 ${bare_field_name} 
*/

  3. 导入、导出注释模板

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

本文参与 腾讯云自媒体同步曝光计划,分享自作者个人站点/博客。
原始发表:2014-09-23 ,如有侵权请联系 cloudcommunity@tencent.com 删除

本文分享自 作者个人站点/博客 前往查看

如有侵权,请联系 cloudcommunity@tencent.com 删除。

本文参与 腾讯云自媒体同步曝光计划  ,欢迎热爱写作的你一起参与!

评论
登录后参与评论
暂无评论
推荐阅读
编辑精选文章
换一批
【java基础】Eclipse Java注释模板设置详解以及版权声明
本文转载自:https://www.cnblogs.com/lr393993507/p/5867623.html
用户5640963
2019/07/25
8700
Eclipse注释模板设置详解
设置注释模板的:Window --> Preference --> Java->Code Style --> Code Template 然后展开Comments节点就是所有需设置注释的元素。本文现就每一个元素逐一给大家介绍一下。
黑泽君
2018/12/19
5.4K0
Java技巧收录一 那些你相见恨晚的快捷键和代码注释模板
设置注释模板的入口:Window->Preference->Java->Code Style->Code Template 然后展开Comments节点就是所有需设置注释的元素。
glm233
2020/09/28
4240
Eclipse基础设置
• 设置自动联想提示 Window -> Preferences -> Java -> Editor -> Content Assist -> Auto Activation • 设置格式化模板 window->preferences->Java->Code Style->Formatter
Kevin_Zhang
2021/06/10
7730
eclipse方法自动注释_eclipse快速补全
1、Eclipse自动补全功能设置,默认是键入“.”才会有代码提示,否则就只有按“Alt+/”组合键。通过下面的设置可以按照你自己的需求显示代码提示。 1)、直接设置 打开 Eclipse -> Window -> Perferences->Java->Editor->Content Assist,右边出现的选项中,有一个Auto activation triggersor for Java ,
全栈程序员站长
2022/11/10
1.5K0
eclipse 设置注释模板详解,与导入模板方法介绍总结
在开发中进入项目组,一定要先问下项目经理,有没有这个代码注释模板,然后倒入到你的eclipse 中,还有注意设置 utf-8 。下面就是导入注释模板的方法:
斯文的程序
2019/11/07
8110
eclipse 设置注释模板详解,与导入模板方法介绍总结
Eclipse/MyEclipse的快捷键以及文档注释、多行注释的快捷键
  1.选中你要加注释的区域,用 Ctrl+Shift+C 或者 Ctrl+/ 会加上 // 注释,再重复按一下就会去掉 // 注释。(.js文件中只有 Ctrl+Shift+C 管用,.java文件中都管用)
黑泽君
2018/10/11
4.3K0
Eclipse/MyEclipse的快捷键以及文档注释、多行注释的快捷键
Java 注释
编写程序的时候,总需要为程序添加一些注释,用以说明某段代码的作用,或者说明某个类的用途,某个方法的工能,以及该方法的的参数和返回值的数据类型以及意义等
全栈程序员站长
2022/09/15
1.2K0
javaSE-第一个java程序
JokerDJ
2023/11/27
1240
javaSE-第一个java程序
eclipse运行环境配置_eclipse如何配置环境
1、想要配置Eclipse的环境,就要先下载Eclipse,并安装它,不会下载安装的小伙伴可以点击下面给的链接,里面有我写的详细的教程,这里就不重复了
全栈程序员站长
2022/08/02
7.2K0
eclipse运行环境配置_eclipse如何配置环境
DOC文档注释,让你的代码如此清晰。
1.开发背景 最近一直在写dubbo接口,以前总是用word文档写接口描述然后发给别人。现在太多了,而且跟别人对接联调的人家急着用,根本没时间去写word文档。那就想想怎么用doc文档注释自动生成接口文档了。本来以前对这一块有点印象,但是并不熟悉,加上没有很强烈的要去使用的意图,所以一直没有弄。今天要感谢公司的大神,大家都叫他欧神,神一样的男人。让我用文档注释。然后就知道怎么弄了,以下是生成的流程。 2.生成方法 先说生成的方法吧,免得一开始将注释规范可能读者觉得比较繁琐,而且注释规范基本上大家都有一套自己
三哥
2018/06/15
1.5K0
Java注释说明以及IDEA中的快捷键
IDEA中的快捷键:使用 Ctrl+Shift+ /, 添加块注释,再次使用,去掉块注释;*/
栗筝i
2022/12/01
1K0
【愚公系列】2021年12月 Java教学课程 04-Java语言三种注释
注释就是对代码的解释和说明,其目的是让人们能够更加轻松地了解代码。注释是编写程序时,写程序的人给一个语句、程序段、函数等的解释或提示,能提高程序代码的可读性。
愚公搬代码
2021/12/28
1610
大数据必学Java基础(八):简单介绍API和注释
其实API没有什么神奇的,就是一个电子文档而已,帮助我们查看JAVA中涉及到的一些技能点
Lansonli
2022/07/04
4510
大数据必学Java基础(八):简单介绍API和注释
Java的三种注释
包含在“/*”和“*/”之间,能注释很多行的内容。为了可读性比较好,一般首行和尾行不写注释信息(这样也比较美观好看),如图所示。
全栈程序员站长
2022/09/08
8580
Java的三种注释
Eclipse 的快捷键以及文档注释、多行注释的快捷键[通俗易懂]
大家好,又见面了,我是你们的朋友全栈君。 其实快捷键可以自己设定:eclipse>>>window>>>preferences>>>keys
全栈程序员站长
2022/08/03
3.6K0
Eclipse 的快捷键以及文档注释、多行注释的快捷键[通俗易懂]
规范JavaScript注释
//(双斜线)与代码之间保留一个空格,并且//(双斜线)与注释文字之间保留一个空格。
Dreamy.TZK
2020/06/28
13.3K0
编写高质量可维护的代码:一目了然的注释
有一些人认为,好的代码是自我解释的。合适的命名和优秀的代码的确可以减轻开发人员阅读代码的工作量,对于不是特别复杂的代码可能确实可以做到自我解释。但并不是所有场景都可以做到这一点,我们一起来了解一下“注释”吧。
政采云前端团队
2020/10/09
1.2K0
编写高质量可维护的代码:一目了然的注释
滚雪球学Java(10):Java注释
咦咦咦,各位小可爱,我是你们的好伙伴——bug菌,今天又来给大家普及Java SE相关知识点了,别躲起来啊,听我讲干货还不快点赞,赞多了我就有动力讲得更嗨啦!所以呀,养成先点赞后阅读的好习惯,别被干货淹没了哦~
bug菌
2024/04/28
1140
滚雪球学Java(10):Java注释
Python中的单行、多行、中文注释
如果文件里有非ASCII字符,需要在第一行或第二行指定编码声明。把ChineseTest.py文件的编码重新改为ANSI,并加上编码声明:
py3study
2020/01/12
2.4K0
相关推荐
【java基础】Eclipse Java注释模板设置详解以及版权声明
更多 >
领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档
查看详情【社区公告】 技术创作特训营有奖征文