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

在IDEA中配置注释模板

为了统一项目代码规范,要求大家都统一Java类和方法注释,如下:

类注释格式:

/*** <p>描述:${DESCRIPTION}</p>** @author ${USER}* @date ${DATE} ${TIME}* @version 1.0*/

方法注释格式:

/*** TODO: 方法功能描述* @author ${USER}* @since $date$ $time$* @param $param$* @return $return$*/

在IDEA中可以分别添加如下类注释模板和方法注释模板:

配置路径:Editor > Live Templates

第一步:新建Template Group,命名为:ccc(也可以命名为其他任意名称)
第二步:在上一步新建的Template Group中新建Live Template

新建类注释模板:
Abbreviation:ccc(也可以指定其他任意字符,就是一个快速添加注释的缩写)
Description:类注释模板
Template text:

/*** <p>描述:${DESCRIPTION}</p>* @author $USER$* @date $DATE$* @version 1.0*/

变量值:
USER:可以为固定值,也可以使用表达式取值,如:admin(固定值),user()(表达式取值)。
DATE:date("yyyy.MM.dd HH:mm:ss")

应用范围:Java -> Declaration
类注释

在需要添加注释的类名上面输入:ccc + TAB就可以快速添加类注释。

新建方法注释模板:
Abbreviation:*(只能用星号,不能用其他字符)
Description:方法注释模板
Template text:

** TODO: 方法功能描述* @author $USER$* @since $DATE$
$PARAMS$* @return*/

变量值:
USER:可以为固定值,也可以使用表达式取值,如:admin(固定值),user()(表达式取值)。
DATE:date("yyyy.MM.dd HH:mm:ss")
PARAMS:

groovyScript("def params = _1; if (params == null || params.isEmpty()) return ''; def result = ''; for (i = 0; i < params.size(); i++) { result += ' * @param ' + params[i] + (i < params.size() - 1 ? '\\n' : '') }; return result", methodParameters())

应用范围:Java -> Comment
方法注释

在需要添加注释的方法名上面输入:/** + TAB快速添加方法注释。

http://www.jsqmd.com/news/476221/

相关文章:

  • AI录音笔品牌价格多少,哪家性价比高值得选? - myqiye
  • 4GB显存神器Chandra OCR部署实战:从环境搭建到批量处理全流程
  • 2026年口碑好的超声波喷涂机国产品牌推荐,你了解几家 - 工业设备
  • cv_resnet50_face-reconstruction在心理学研究中的应用:微表情分析
  • Qwen3-TTS声音设计保姆级教程:从部署到生成你的第一个AI语音
  • Real-ESRGAN超分模型在TensorRT上的3种加速方案实测对比(含动态尺寸支持)
  • SmallThinker-3B-Preview开发入门:IntelliJ IDEA插件开发与模型API调用
  • CHORD-X视觉系统与STM32嵌入式平台联动开发指南
  • USB Type-C设计必看:EMS4100N模拟开关的5个实战应用技巧
  • 地奇星RA6E2开发板CGC时钟系统详解:从时钟源到时钟树配置
  • Node.js后端服务集成通义千问AI能力:从环境配置到API路由设计
  • 5G定位实战:Multi-RTT技术如何解决室内外无缝定位难题(附3GPP TS 38.305 V18配置示例)
  • 小白也能玩转DeerFlow:快速部署AI研究助手,自动生成播客内容
  • SOONet与Java集成开发:构建企业级视频内容审核系统
  • 立创EDA训练营:基于ESP32-C3与DS1302的物联网数码管时钟设计与3D打印桌搭实战
  • PowerPaint-V1 Gradio基础教程:Mask绘制技巧与区域精度控制最佳实践
  • 2026年用户口碑推荐的临沂黄金回收店盘点:五家真实服务体验与可靠性验证 - 十大品牌推荐
  • 低成本GPU算力方案:mPLUG-Owl3-2B让2B多模态模型在边缘设备稳定运行
  • eNSP避坑指南:虚拟机Ping不通模拟设备的5个常见原因及解决方法
  • 2026年婚姻家事必看:杭州离婚律师选型指南与精准适配策略实测 - 品牌推荐
  • 时间序列预测新思路:用LSTM+差分注意力iTransformer预测光伏发电量(含数据/模型对比)
  • ClawdBot新手入门:从零开始部署vllm后端AI助手全攻略
  • Z-Image-Turbo-辉夜巫女多风格作品集:写实、动漫与抽象艺术效果对比
  • Alpamayo-R1-10B高效推理指南:单次inference耗时<8s(A100 40GB实测),支持实时交互
  • 使用LaTeX与AgentCPM自动生成格式精美的学术型研报
  • 2026年杭州离婚律师权威榜单发布:五大律师专业实力深度排位赛 - 品牌推荐
  • #第七届立创电赛# 基于国民技术N32G430与INA199的USB电流电压功率监测仪设计与实现
  • CLIP-GmP-ViT-L-14图文匹配测试工具结合ComfyUI:构建可视化AI工作流
  • 3个核心价值:Navicat试用期重置工具的创新解决方案
  • 赋能内容创作:Nunchaku-flux-1-dev集成微信公众号小程序开发