当前位置: 首页 > news >正文

idea配置代码注释模板

  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)设置模板:模板内容如下

注意第一行,只有一个*而不是/*

在设置参数名时必须用${参数名}$的方式,否则第五步中读取不到你设置的参数名

代码语言:javascript

代码运行次数:0

运行

AI代码解释

** @Author chengpunan* @Description //TODO $end$* @Date $time$ $date$* @Param $param$* @return $return$**/

如果使用/*生成的模板注释将会是如下效果:所以我们要去掉最前面的/*

(5)设置模板的应用场景

点击模板页面最下方的警告,来设置将模板应用于那些场景,一般选择EveryWhere-->Java即可

(如果曾经修改过,则显示为change而不是define)

(6)设置参数的获取方式

选择右侧的Edit variables按钮

PS:第五步和第六步顺序不可颠倒,否则第六步将获取不到方法

选择每个参数对应的获取方法(在下拉选择框中选择即可),网上有很多教程说获取param时使用脚本的方式,我试过使用脚本

的方式不仅麻烦而且只能在方法内部使用注释时才能获取到参数

(7)效果图

创建方法,在方法上面写:/*+模板名+Enter-->/**+Enter

http://www.dtcms.com/a/565450.html

相关文章:

  • 前端文件上传终极指南:从原理到架构实践!
  • 【一问专栏】链表:数据世界的“寻宝游戏“——详解应用场景与独特优势
  • Linux 线程
  • 【Android项目】KMMV项目随笔
  • vmware windows和linux系统共享和映射物理机目录
  • 机器学习日报11
  • 宿州品牌网站建设公司淘宝网站建设单子好接吗
  • 大数据成矿预测系列(六) | 从“看图像”到“读结构”:图卷积神经网络如何赋能地质“图谱”推理
  • AI研究-118 具身智能 Mobile-ALOHA 解读:移动+双臂模仿学习的开源方案(含论文/代码/套件链接)
  • 超越“盒子”:虚拟机在云计算与AI时代的颠覆性未来应用展望
  • 外国人可以在中国做网站吗cnzz网站建设
  • 网站建设色彩搭配做黄图网站接广告好赚吗
  • 云手机运行 技术革新
  • 安徽省建设厅网站电话网站开发明细
  • 电脑手机蓝牙远程控制系统代码三篇
  • nacos增加配置时报错
  • SQL Schema Compare:一款免费开源的数据库结构比较和同步工具
  • 北京电信备案网站做茶道网站
  • C语言实现状态模式
  • SQLite 常用函数
  • 青岛seo网站推广广告电商
  • app软件小程序网站建设wordpress jetpack 慢
  • 2G2核服务器安装ES
  • 大规模图片列表性能优化:基于 IntersectionObserver 的懒加载与滚动加载方案
  • CANN算子开发实战:从矩阵乘法到高性能优化
  • 网站推广教程分享wordpress 阴影
  • 从协议规范和使用场景探讨为什么SmartMediaKit没有支持DASH
  • 【工程开发】GLM-4.1V调试
  • Fiddler抓包手机和部分app无法连接网络问题
  • 【开题答辩全过程】以 二手咸鱼手机交易平台为例,包含答辩的问题和答案