-
IDEA类和方法注释模板设置(非常详细)
2018-01-11 10:41:44IDEA自带的注释模板不是太好用,我本人到网上搜集了很多资料系统的整理了一下制作了一份比较完整的模板来分享给大家,我不是专业玩博客的,写这篇文章只是为了让大家省事。 这里设置的注释模板采用Eclipse的格式,...IDEA自带的注释模板不是太好用,我本人到网上搜集了很多资料系统的整理了一下制作了一份比较完整的模板来分享给大家,我不是专业玩博客的,写这篇文章只是为了让大家省事。
这里设置的注释模板采用Eclipse的格式,下面先贴出Eclipse的注释模板,我们就按照这种格式来设置:
类注释模板: 方法注释模板:
一、首先我们来设置IDEA中类的模板:(IDEA中在创建类时会自动给添加注释)
1、File-->settings-->Editor-->File and Code Templates-->Files
我们选择Class文件(当然你要设置接口的还也可以选择Interface文件)
(1)${NAME}:设置类名,与下面的${NAME}一样才能获取到创建的类名
(2)TODO:代办事项的标记,一般生成类或方法都需要添加描述
(3)${USER}、${DATE}、${TIME}:设置创建类的用户、创建的日期和时间,这些事IDEA内置的方法,还有一些其他的方法在绿色框标注的位置,比如你想添加项目名则可以使用${PROJECT_NAME}
(4)1.0:设置版本号,一般新创建的类都是1.0版本,这里写死就可以了
2、效果图展示
二、设置方法注释模板
IDEA还没有智能到自动为我们创建方法注释,这就是要我们手动为方法添加注释,使用Eclipse时我们生成注释的习惯是
/**+Enter,这里我们也按照这种习惯来设置IDEA的方法注释
1、File-->Settings-->Editor-->Live Templates
(1)新建组:命名为userDefine
(2)新建模板:命名为*
因为IDEA生成注释的默认方式是:/*+模板名+快捷键(比如若设置模板名为add快捷键用Tab,则生成方式为
/*add+Tab),如果不采用这样的生成方式IDEA中没有内容的方法将不可用,例如获取方法参数的methodParameters()、
获取方法返回值的methodReturnType()
(3)设置生成注释的快捷键
(4)设置模板:模板内容如下
注意第一行,只有一个*而不是/*
在设置参数名时必须用${参数名}$的方式,否则第五步中读取不到你设置的参数名
注意:下面这段是代码,可以直接复制的!可以直接复制的!可以直接复制的!不要再问我为什么都是图片了,留着眼睛干啥?
* * @Author liu-miss * @Description //TODO $end$ * @Date $time$ $date$ * @Param $param$ * @return $return$ **/
如果使用/*生成的模板注释将会是如下效果:所以我们要去掉最前面的/*
(5)设置模板的应用场景
点击模板页面最下方的警告,来设置将模板应用于那些场景,一般选择EveryWhere-->Java即可
(如果曾经修改过,则显示为change而不是define)
(6)设置参数的获取方式
选择右侧的Edit variables按钮
PS:第五步和第六步顺序不可颠倒,否则第六步将获取不到方法
选择每个参数对应的获取方法(在下拉选择框中选择即可),网上有很多教程说获取param时使用脚本的方式,我试过使用脚本
的方式不仅麻烦而且只能在方法内部使用注释时才能获取到参数
(7)效果图
创建方法,在方法上面写:/*+模板名+Enter-->/**+Enter
-
注释
2020-11-02 15:52:31什么是注释? 注释的分类 单行注释 多行注释 Python程序中 · 中文支持 总结 什么是注释? 通过用自己熟悉的语言,在程序中对某些代码进行标注说明,这就是注释的作用,能够大大增强程序的可读性。 ...目录
什么是注释?
通过用自己熟悉的语言,在程序中对某些代码进行标注说明,这就是注释的作用,能够大大增强程序的可读性。
注释的分类
单行注释
1)以 # 开头,# 右边的所有东西当做说明,而不是真正要执行的程序,起辅助说明作用
#!/usr/bin/python #coding=utf-8 print("welcome to hya") #我是注释这行我要打印这串字符
多行注释
1)多行注释类似说明的一种
''' 我是多行注释,可以写很多很多行的功能说明 下面第一行是编译器 第二行是字符集 第三行我要打印这串字符 很牛x是不是 哈哈哈。。。 ''' #!/usr/bin/python #coding=utf-8 print("welcome to hya")
Python程序中 · 中文支持
1)我们首先在程序中打印一串中文
#!/usr/bin/python #coding=utf-8 print("我是韩大本事,今年24岁了")
2)执行
[root@hya ~]# python3 python.py 我是韩大本事,今年24岁了 ####我们发现打印成功了,这是为什么呢? 提示:在脚本中设置中文字符集
3)在python的语法规范中使用的方式应该是这样
# -*- coding:utf-8 -*-
总结
噗嗤,我自己都感觉自己写这篇有点太....了,不过也还是要记录一下,虽然这块并不是很重要,也不是太难。
-
linux2.6.1内核源码注释
2014-03-10 15:21:33包含LINUX内核同步、信号、内存、调度、文件系统、网络系统、时钟等部分的源码注释。前后历时三年,算是干货。 -
VScode注释与取消注释快捷键
2018-09-05 10:05:24 -
VS 注释多行与取消多行注释快捷键
2017-04-13 17:12:10 -
Linux2.6.24内核注释
2014-05-29 22:42:05所有注释都是中文,您可以与标准2.6.24内核进行比较,看看具体的注释内容。 针对2.6.24注释的时间比较短,内容不多,抱歉,请不要拍砖。更多的注释是针对linux2.6.11.12内核的,您可以通过... -
mysql 修改表注释、字段注释、查看与修改注释
2018-05-23 14:36:082018年5月23日1 创建表的时候写注释create table test1(field_name int comment '字段的注释')comment='表的注释';2 修改表的注释alter table test1 comment '修改后的表的注释';3 修改字段的注释alter table test1 ... -
优秀的程序员真的不写注释吗?
2020-05-11 07:02:23我在很多地方看到这样一个观点,“请停止写注释,因为只有烂的代码才需要注释。”这个观点非常巧妙,它让我想起了孟子的一句话,“杨氏为我,是无君也;墨氏兼爱,是无父也。无父无君,是禽兽也。” 动不动就骂别人... -
VS Code注释快捷键
2018-12-24 11:20:45单行注释: Ctrl + / 或先按CTRL+K,再按CTRL+U 取消单行注释: Ctrl + / 或先按CTRL+U,再按CTRL+K 块注释 Alt + Shift + A -
html——注释(单行注释 多行注释)
2018-07-26 21:22:49--这是单行注释--> <!-- 这是多行注释 这是多行注释 这是多行注释 --> JS/jQuery注释: //这是单行注释 /* 这是多行注释 这是多行注释 这是多行注释 */ css注释: /*这是... -
idea生成类注释和方法注释的正确方法
2017-11-01 01:42:41生成类注释 生成类注解模板 生成方法注释 生成方法注解模板 最近从eclipse转idea了,第一步当然是配置快捷键,模板等。但是!发生了一件贼蛋疼的事情,竟然一直找不到正确添加方法注释的方法! 最后自己摸索到了,... -
python-注释和取消注释多行程序
2018-09-13 15:56:21在程序中,有时候想把多行程序注释掉,一行一行的注释比较麻烦,那么可以多行注释吗,可以,有如下几种方法: 1.选中要注释的段落,按下ctrl+/,效果如下: 再按一下ctrl+/,取消注释 2.将一整段用三个双引号... -
Source Insight 中文注释为乱码解决办法(完美解决,一键搞定)
2017-04-14 17:52:54错误现象:注释乱码,查了好多,肯定是编码显示问题: 现象如图所示: 网上找了很多解决办法,都是很多年前的了,解决起来太麻烦。最后我在这里官方支持文章中找到了答案: Unfortunately, the code page encoding ... -
解决:xml文件单行注释、多行注释问题
2019-09-18 15:48:10【解决:xml文件中的单释、多行注释问题】 第一种(单行): <!-- 注释内容 --> 第二种(多行): <!-- 注释内容(无其他注释符) ... -
idea设置类注释和方法注释模板
2018-01-16 10:07:271、设置类注释模板 这样在定义类时,都要多输入类的描述。不想的话,可以删去 ${description} 2、方法注释模板 先新建模板组,名字自己起。 然后选中自己的模板组,在模板组下新建模板 如下图给... -
eclipse 中的注释 快捷键 多行注释快捷键 单行注释快捷键
2017-07-27 11:27:48Eclipse 中的两种注释方法: (1)多行注释 (2)单行注释 一、 多行注释快捷键 1:添加注释 Ctrl+Shift+/ : 添加/* */注释 示例: 选中代码块后按下快捷键即可 /* float size = 0.0f; float pct = 0.0f; try... -
给json加注释
2019-06-29 19:33:57我们要知道的是在json文件中用传统的注释格式(// /**/)进行注释,是不符合json规范的。 json里面有自己约定俗成的注释规范。 1、在json文件中,采用"//",其value就是添加的注释内容。 { "//": "设置起始刻度, ... -
IntelliJ IDEA添加注释常用的快捷键
2018-07-24 09:38:34IDEA可以使用快捷键添加行注释Ctrl+/、块注释Ctrl+Shift+/,还可以快速生成类注释、方法注释等,下面就介绍这几种快捷键的用法. [1]行注释Ctrl+/ 首先你的光标要处于这一行,处于这行的哪个位置都可以,按Ctrl+/,就... -
Python注释方式有哪些
2019-01-03 15:36:08注释是对一段代码的解释和说明,可提高程序代码的可读性,让人们能够更加轻松地了解代码,尤其在大型项目开发和团队项目中,注释是必不可少的! 任何编程语言都少不了注释,Python也不例外,以下是Python注释的具体... -
shell脚本——注释(单行注释 多行注释)
2018-06-15 13:44:11单行注释以"#"开头的行就是注释,会被解释器忽略。#-------------------------------------------- # 这是一个注释 # author:菜鸟教程 # site:www.runoob.com # slogan:学的不仅是技术,更是梦想! #--... -
Idea 添加注释:类注释、方法注释(可获取参数)
2018-11-15 15:01:07Idea 添加注释:类注释、方法注释类注释方法注释 类注释 File–Setting–Editor–File and Code Templates–Class: 注释模板:/** * * *@description: *@author: Andy *@time: ${DATE} ${TIME} * */ ... -
Java注释
2019-09-28 22:23:28定义 用于解释说明程序的文字 分类 单行注释 格式: // 注释文字 ...注释的内容在程序编译的时候会被忽视,不会产生目标代码,注释的部分不会对程序的执行结果产生任何影响。 注意事项 多行和文档注释都不能... -
SQL单行注释和多行注释
2018-07-03 20:24:11单行注释:-- 例如--单行注释 SELECT * FROM talbe;多行注释: /* */ 例如:/* 此处 为多行注释内容 */ SELECT * FROM table; -
python 单行注释 多行注释 批量注释 中文注释
2017-07-13 15:17:05Python 中的注释有多种,有单行注释,多行注释,批量注释,中文注释也是常用的。python注释也有自己的规范,在文章中会介绍到。注释可以起到一个备注的作用,团队合作的时候,个人编写的代码经常会被多人调用,为了... -
Eclipse中各种常用文件的注释与取消注释的快捷键
2018-01-26 15:22:17注释和取消注释的快捷键都是:CTRL + /或 Shift+Ctrl+C JS文件: 注释和取消注释的快捷键都是:CTRL + /或 Shift+Ctrl+C xml文件: 注释:选中要注销的代码CTRL + SHIFT + / 或 选中代码按Shift+Ctrl+C 取消... -
注释(单行注释、多行注释、文档注释)
2018-12-07 17:47:20注释的内容不会出现在字节码中,即java编译器编译时会跳过注释语句,在java中根据注释的功能不同,主要分为单行注释、多行注释和文档注释。 1,单行注释 单行注释是以“//”开头的后面的内容就是注释。 2,多行注释 ... -
git修改已commit的注释信息
2018-06-27 14:05:20有时候commit后发现注释不太合适需要修改,网上查找了一些方法,经测试后整理一下。 环境:windows 情况:commit后未push 修改前情况: 修改步骤 1、输入命令,进入vim界面 git commit –amend ... -
Java 注释
2019-01-22 14:49:37(一)注释的重要性 编写程序的时候,总需要为程序添加一些注释,用以说明某段代码的作用,或者说明某个类的用途,某个方法的工能,以及该方法的的参数和返回值的数据类型以及意义等 程序注释的作用非常大,很... -
IntelliJ IDEA设置类注释和方法注释模板
2018-06-03 15:53:21IntelliJ IDEA设置类注释和方法注释模板1、设置类注释模板这样在定义类时,都要多输入类的描述。不想的话,可以删去 ${description}2、方法注释模板先新建模板组,名字自己起。然后选中自己的模板组,在模板组下...
-
网站评估工作表.doc
-
java 冒泡排序实现代码
-
python:记录python的常规操作-源码
-
java的类型转换和内存溢出说明
-
android原生开发!12个View绘制流程高频面试题,看这一篇就够了!
-
高盛VR与AR报告:下一个通用计算平台.pdf
-
vue3从0到1-超详细
-
MySQL 高可用工具 DRBD 实战部署详解
-
FFmpeg4.3系列之16:WebRTC之小白入门与视频聊天的实战
-
【正点原子】I.MX6U 出厂系统Qt交叉编译环境搭建V1.4.pdf
-
裕网云综合导航源码
-
android最新版本!抖音四面被拒,再战头条终获offer,附赠课程+题库
-
零基础一小时极简以太坊智能合约开发环境搭建并开发部署
-
Mysql数据库面试直通车
-
linux基础入门和项目实战部署系列课程
-
Windows系统管理
-
《Visual C# 2010 Step by Step》
-
项目管理工具与方法
-
JMETER 性能测试基础课程
-
基于Flink+Hudi构建企业亿级云上实时数据湖教程(PC、移动、小