设置注释模板

IDEA类和方法注释模板设置(超详细教程) create:YEAR−HOUR{MINUTE}**/方法模板注释:end@Datetimedate@Paramparam@returnreturn**/ 阅读详情

设置注释模板的入口: Window->Preference->Java->Code Style->Code Template 然后展开Comments节点就是所有需设置注释的元素啦。现就每一个元素逐一介绍:

文件(Files)注释标签:

/**    
* @Title: ${file_name}  
* @Package ${package_name}  
* @Description: ${todo}(用一句话描述该文件做什么)  
* @author A18ccms A18ccms_gmail_com    
* @date ${date} ${time}  
* @version V1.0    
*/

类型(Types)注释标签(类的注释):

/**  
* @ClassName: ${type_name}  
* @Description: ${todo}(这里用一句话描述这个类的作用)  
* @author A18ccms a18ccms_gmail_com  
* @date ${date} ${time}  
*  
* ${tags}  
*/

字段(Fields)注释标签:

/**  
* @Fields ${field} : ${todo}(用一句话描述这个变量表示什么)  
*/  
构造函数标签:

/**  
* <p>Title: </p>  
* <p>Description: </p>  
* ${tags}  
*/

方法(Constructor & Methods)标签:

/**  
* @Title: ${enclosing_method}  
* @Description: ${todo}(这里用一句话描述这个方法的作用)  
* @param ${tags}    设定文件  
* @return ${return_type}    返回类型  
* @throws  
*/

覆盖方法(Overriding Methods)标签:

/* (非 Javadoc)  
* <p>Title: ${enclosing_method}</p>  
* <p>Description: </p>  
* ${tags}  
* ${see_to_overridden}  
*/

代表方法(Delegate Methods)标签:

/**  
* ${tags}  
* ${see_to_target}  
*/  
getter方法标签:

/**  
* @return ${bare_field_name}  
*/

setter方法标签:

/**  
* @param ${param} 要设置的 ${bare_field_name}  
*/ 
例子:  
<?xml version="1.0" encoding="UTF-8"?>  
<templates>  
    <template     
                autoinsert="false"     
                context="constructorcomment_context"     
                deleted="false"     
                description="Comment for created constructors"     
                enabled="true"     
                id="org.eclipse.jdt.ui.text.codetemplates.constructorcomment"  
                name="constructorcomment">  
    /**    
     * 创建一个新的实例 ${enclosing_type}.    
     *    
     * ${tags}    
     */    
    </template>  
    <template     
                autoinsert="true"     
                context="settercomment_context"  
                deleted="false"     
                description="Comment for setter method"     
                enabled="true"     
                id="org.eclipse.jdt.ui.text.codetemplates.settercomment"     
                name="settercomment">  
    /**    
     * @param ${param} the ${bare_field_name} to set    
     */    
    </template>  
    <template  
                autoinsert="false"     
                context="methodcomment_context"     
                deleted="false"     
                description="Comment for non-overriding methods"     
                enabled="true"     
                id="org.eclipse.jdt.ui.text.codetemplates.methodcomment"     
                name="methodcomment">  
    /**    
     * 此方法描述的是:    
     * @author: wanghui-hd2007@163.com 
     * @version: ${date} ${time}    
     */    
    </template>  
    <template     
                autoinsert="true"     
                context="delegatecomment_context"     
                deleted="false"     
                description="Comment for delegate methods"     
                enabled="true"     
                id="org.eclipse.jdt.ui.text.codetemplates.delegatecomment"     
                name="delegatecomment">  
    /**    
     * ${tags}    
     * ${see_to_target}    
     */    
    </template>  
    <template  
                autoinsert="false"     
                context="filecomment_context"     
                deleted="false"     
                description="Comment for created Java files"     
                enabled="true"     
                id="org.eclipse.jdt.ui.text.codetemplates.filecomment"     
                name="filecomment">  
    /**    
     * 文件名:${file_name}    
     *    
     * 版本信息:    
     * 日期:${date}    
     * Copyright 足下 Corporation ${year}     
     * 版权所有    
     *    
     */    
    </template>  
    <template     
                autoinsert="false"     
                context="gettercomment_context"     
                deleted="false"     
                description="Comment for getter method"     
                enabled="true"     
                id="org.eclipse.jdt.ui.text.codetemplates.gettercomment"     
                name="gettercomment">  
    /**    
     * ${bare_field_name}    
     *    
     * @return the ${bare_field_name}    
     * @since   CodingExample Ver(编码范例查看) 1.0    
    */    
    </template>  
    <template     
                autoinsert="true"     
                context="overridecomment_context"     
                deleted="false"     
                description="Comment for overriding methods"     
                enabled="true"     
                id="org.eclipse.jdt.ui.text.codetemplates.overridecomment"     
                name="overridecomment">  
    /* (non-Javadoc)    
     * ${see_to_overridden}    
     */    
    </template>  
    <template     
                autoinsert="false"     
                context="fieldcomment_context"     
                deleted="false"     
                description="Comment for fields"     
                enabled="true"     
                id="org.eclipse.jdt.ui.text.codetemplates.fieldcomment"     
                name="fieldcomment">  
    /**    
     * ${field}:${todo}(用一句话描述这个变量表示什么)    
     *    
     * @since Ver 1.1    
     */    
    </template>  
    <template     
                autoinsert="false"     
                context="typecomment_context"     
                deleted="false"     
                description="Comment for created types"     
                enabled="true"     
                id="org.eclipse.jdt.ui.text.codetemplates.typecomment"     
                name="typecomment">  
    /**    
     * 此类描述的是:    
     * @author: wanghui-hd2007@163.com

     * @version: ${date} ${time}     
     */    
    </template>  
</templates>  
<?xml version="1.0" encoding="UTF-8"?>  
<templates>  
    <template  
                autoinsert="false"  
                  context="constructorcomment_context"  
                deleted="false"  
                description="Comment for created constructors"  
                enabled="true"  
                id="org.eclipse.jdt.ui.text.codetemplates.constructorcomment"  
                name="constructorcomment">  
    /**  
     * 创建一个新的实例 ${enclosing_type}.  
     *  
     * ${tags}  
     */  
    </template>  
    <template  
                autoinsert="true"  
                context="settercomment_context"  
                deleted="false"  
                description="Comment for setter method"  
                enabled="true"  
                id="org.eclipse.jdt.ui.text.codetemplates.settercomment"  
                name="settercomment">  
    /**  
     * @param ${param} the ${bare_field_name} to set  
     */  
    </template>  
    <template  
                autoinsert="false"  
                context="methodcomment_context"  
                deleted="false"  
                description="Comment for non-overriding methods"  
                enabled="true"  
                id="org.eclipse.jdt.ui.text.codetemplates.methodcomment"  
                name="methodcomment">  
    /**  
     * 此方法描述的是:  
     * @author: wanghui-hd2007@163.com

     * @version: ${date} ${time}  
     */  
    </template>  
    <template  
                autoinsert="true"  
                context="delegatecomment_context"  
                deleted="false"  
                description="Comment for delegate methods"  
                enabled="true"  
                id="org.eclipse.jdt.ui.text.codetemplates.delegatecomment"  
                name="delegatecomment">  
    /**  
     * ${tags}  
     * ${see_to_target}  
     */  
    </template>  
    <template  
                autoinsert="false"  
                context="filecomment_context"  
                deleted="false"  
                description="Comment for created Java files"  
                enabled="true"  
                id="org.eclipse.jdt.ui.text.codetemplates.filecomment"  
                name="filecomment">  
    /**  
     * 文件名:${file_name}  
     *  
     * 版本信息:  
     * 日期:${date}  
     * Copyright 足下 Corporation ${year}  
     * 版权所有  
     *  
     */  
    </template>  
    <template  
                autoinsert="false"  
                context="gettercomment_context"  
                deleted="false"  
                description="Comment for getter method"  
                enabled="true"  
                id="org.eclipse.jdt.ui.text.codetemplates.gettercomment"  
                name="gettercomment">  
    /**  
     * ${bare_field_name}  
     *  
     * @return the ${bare_field_name}  
     * @since   CodingExample Ver(编码范例查看) 1.0  
    */  
    </template>

    <template  
                autoinsert="true"  
                context="overridecomment_context"  
                deleted="false"  
                description="Comment for overriding methods"  
                enabled="true"  
                id="org.eclipse.jdt.ui.text.codetemplates.overridecomment"  
                name="overridecomment">  
    /* (non-Javadoc)  
     * ${see_to_overridden}  
     */  
    </template>  
    <template  
                autoinsert="false"  
                context="fieldcomment_context"  
                deleted="false"  
                description="Comment for fields"  
                enabled="true"  
                id="org.eclipse.jdt.ui.text.codetemplates.fieldcomment"  
                name="fieldcomment">  
    /**  
     * ${field}:${todo}(用一句话描述这个变量表示什么)  
     *  
     * @since Ver 1.1  
     */  
    </template>  
    <template  
                autoinsert="false"  
                context="typecomment_context"  
                deleted="false"  
                description="Comment for created types"  
                enabled="true"  
                id="org.eclipse.jdt.ui.text.codetemplates.typecomment"  
                name="typecomment">  
    /**  
     * 此类描述的是:  
     * @author: wanghui-hd2007@163.com

     * @version: ${date} ${time}  
     */  
    </template>  
</templates>

MyEclipse 6.5 代码提示的设置

MyEclipse 选择 Windows ->Preperences ->General ->keys

找到 word completion的快捷键 把原alt+/删掉!//必须

把Content Assist 的快捷键 改成alt+/ 或者你想改的其他快捷键

MyEclipse编码设置

Myeclipse安装后编码默认是GB18030,一般推荐用UTF-8。如果在导入项目后发现乱码现象,那是编码设置设置不对。

全局编码设置的方法:ToolBar-->Window-->Preferences-->General-->Workspace-->Text file encoding,设置合适的编码。

局部编码设置:在源码按右键-->General-->Editors-->Test Editors-->Spelling-->Encoding,这里是设置单个文件的编码。

推荐还是使用全局编码设置。

MyEclipse设置JSP页面默认编码方式:

windows(窗口)-Preferences(首选项)-MyEclipse-Files & Editors-JSP-右侧encoding:设置为ISO10646/Unicode(UTF-8)

MyEclipse在Java文件中设置作者、日期等说明:

windows(窗口)-Preferences(首选项)-Java-Code Style(代码样式)-Code Templates(代码模版)-右侧Comments(注释)-选择Types(类型)-点击edit(编辑)-输入如下信息

/** 
* @包名   ${package_name} 
* @文件名 ${file_name} 
* @作者   汪辉 
* @创建日期 ${date} 
* @版本 V 1.0 
*/

点击OK(确定)-选中左侧的代码样式-选择右侧复选框(Automatically add Comments for new Methods and types)(自动为新方法和类型添加注释)-点击Apply(应用)-点击OK(确定)

关于如何在idea中设置文档注释模板 操作:File -> Settings - > Editor -> File and Code Templates -> Files -> Class在右边的文件框里编辑需要注释的模板,应用保存之后,当我们创建类的时候就会自动生成注释。如果要设置接口的,可以选择Interface文件。 文档注释注释模板: 1、${PROJECT_NAME}:自动获取我们创建的项目名. 2、${NAME}:设置类名,与下面的$ {NAME}一样才能获取到创建的类名 3、TODO:代办事项的标记 阅读详情

相关推荐

Eclipse的Code Templates--绝对可用

Eclipse里面导入该模板,然后写类和方法的时候,就可以自动生成注释了 该模板经过测试,没有问题的

Eclipse配置注释模板(code templates)

Eclipse配置注释模板:code templates首选项位置设置自动添加注释手动配置详细介绍Comments(注释模板):Code(代码模板):注释模板中的常用动态参数说明如下:常用配置记录Comments(注释模板):Files(文件注释):filecomment_contextTypes(文件注释):typecomment_contextFields(类字段注释):fieldcommen...

bellus 3994

从仿真到真机:如何将XTDrone的VINS-Fusion+RTABMap建图方案部署到真实无人机上?

本文详细介绍了如何将XTDrone的VINS-Fusion+RTABMap建图方案从仿真环境迁移到真实无人机上。内容涵盖硬件选型、传感器配置、VINS-Fusion调优、RTABMap性能优化以及系统集成等关键步骤,特别针对三维稠密重建在真实环境中的挑战提供了实用解决方案。

weixin_29056781的博客 242

MyEclipse 注释类及方法等格式设置(Code Templates)

在方法名前 按Alt+Shift+J 可以添加Javadoc 注释 window->preference->java->codestyple->codetemplate->code->New Java  files->edit  ${filecomment} ${package_declaration} /** * @Title: ${file_name} * @

严重浪漫 1902

PythonWeb开发框架—Django之工程创建和models的定义和增删改查

文章介绍了Django工程的创建、models的定义和增删改查

weixin_42476668的博客 991

浅谈车联网概述-1

车联网技术目前在车企中应用广泛,车联网通过车载传感器、无线通信等技术,能够将车辆上百的传感器数据上传至云端,当前智能网联车辆可以理解为一个“大号”手机。

Hello, World! 新能源汽车智能网联工程师,分享日常工作思考。 560

eclipse - 自定义注释模板(Code Template)

编辑注释模板的方法:Window->Preference->Java->Code Style->Code Template然后展开Comments节点就是所有需设置注释的元素啦。现就每一个元素逐一介绍: 1.文件(Files)注释标签: /** * All rights Reserved, Designed By www.witsforce.com * @Title: ${file_name} * @Package ${package_name} *.

沈荣荣的博客 734

多模态情感识别(MER)数据集实战指南:从IEMOCAP到应用落地

本文提供了多模态情感识别(MER)从数据集到应用落地的完整实战指南。以经典IEMOCAP数据集为例,详细讲解了音频、视觉、文本等多模态数据的预处理、特征提取与融合技术,并分享了模型训练调优心得及面向智能客服、在线教育等场景的部署考量,帮助开发者快速构建高效可用的MER系统。

h3i4j的博客 1071

Eclipse Code Templates设置

从工作开始,经历了几个项目的开发,现在的项目一般都是一个团队共同开发,而每个人都有自己的编码习惯,为了统一格式,项目组在项目开发之前都会制定一系列的规范。俗话说约定优于配置,但是在执行过程中往往发现效果不是很好(主要是指编码规范这一方面)。所以我们不得不采取一些措施来协助我们统一项目开发人员的编码风格。主要包括三个方面:设置Code Templates、Eclipse formatter、Chec...

weixin_34395205的博客 453

K230开发板实战:5步搞定YOLOv8模型部署(附常见报错解决方案)

本文提供了一份详细的K230开发板部署YOLOv8模型的实战教程。内容涵盖从环境准备、模型转换到代码编写的完整流程,并重点解析了使用AICube工具链时常见的“生成部署文件异常”等报错解决方案,旨在帮助开发者高效完成嵌入式AI模型部署。

weixin_29053073的博客 786

YOLOv11改进 | 主干/Backbone篇 | 利用RT-DETR主干网络PPHGNetV2助力yolov11有效涨点(轻量化目标检测网络)

本文给大家带来利用RT-DETR模型主干HGNet去替换YOLOv11的主干,RT-DETR是今年由百度推出的第一款实时的ViT模型,其在实时检测的领域上号称是打败了YOLO系列,其利用两个主干一个是HGNet一个是ResNet,其中HGNet就是我们今天来讲解的网络结构模型,这个网络结构目前还没有推出论文,所以其理论知识在网络上也是非常的少,我也是根据网络结构图进行了分析(精度mAP提高0.05)。YOLOv11改进系列专栏——本专栏持续复习各种顶会内容——科研必备​目录一、本文介绍。

Snu77的博客 3721

IDEA中设置注释模板

IDEA中设置注释模板

皮球 3万+

基于FPGA的数字信号处理(11)--定点数的舍入模式(2)向最临近值取整nearest

基于FPGA的数字信号处理(11)--定点数的舍入模式(2)向最临近值取整nearest

孤独的单刀 5475

IDEA设置方法注释模板

IDEA设置方法注释模板类注释模板方法注释模板步骤效果 类注释模板 类注释模板是IDEA创建类是生成的注释,之前发文章跟大家分享过了,而且这也不是本篇文章的重点,文章的链接附在下面,需要的朋友可以去看看。 Intellij IDEA设置类的文件头注释(@Author)(一) Intellij IDEA设置类的文件头注释(之二) 方法注释模板 不管是eclipse还是IDEA都需要我们手动为方法添加注释,使用Eclipse时我们生成注释的习惯是/**+Enter,这里我们也按照这种习惯来设置IDEA的方法注释

Death Note 5万+

c#仿热血江湖

Int32_1 = (int) table.Rows[i]["FLD_初级附魂"],Int32_2 = (int) table.Rows[i]["FLD_中级附魂"],Int32_3 = (int) table.Rows[i]["FLD_是否绑定"],Int32_0 = (int) table.Rows[i]["FLD_进化"],Form1.smethod_1(2, "加载百宝阁物品----没有百宝阁数据");Form1.smethod_1(2, "加载物品商店----没有物品数据");

weixin_42132177的博客 143

OV9734 DATASHEET,完整规格书

OV9734完整规格书,包括电气参数,尺寸规格,寄存器配置表等

Idea设置Java类注释模板和方法注释模板

一、设置类注释模板 1.选择File–&gt;Settings–&gt;Editor–&gt;File and Code Templates–&gt;Includes–&gt;File Header. 注释模板: /** * @Title: ${file_name} * @Package ${package_name} * @Description: ${to...

郭岚的博客 1万+

怀旧版电脑GBC模拟器

再现原版GBC掌机的界面,电脑运行连游戏界面都一样大小,很怀旧,很真实,(英文版)强烈推荐,很小的文件,很难才找到的。

idea设置注释模板

idea注释模板配置

zf_csdn123的博客 3552

老版QQ原生表情gif动态

这是老版的QQ表情,不过全是动态的的,Windows照片查看器是不会动的,可以右击用浏览器打开查看,再说一遍是老版的,只是分享给宁愿用老版也要动态的人。

pscad IEEE标准系统搭建说明

pscad IEEE标准系统搭建说明,包含典型的IEEE 9节点、14节点、30节点、39节点和118节点系统。内含标准测试系统的原始数据和潮流结果。

IntelliJ IDEA设置新建类注释模板和方法注释模板

1、设置新建类注释模板 效果如下: package com.xjt.controller; //类的注释模板 /** * @ClassName sssController * @author: sh * @Description 描述 * @date 2020/11/18 15:00 * @Version 1.0 */ //类 public class sssController { } 1、打开IDEA 点击左上角的File->setting->File And Code Te

sunoob1的博客 1081

Eclipse 注释模板的说明及设置(超详细)

1.在哪里里设置注解模板 设置注释模板的位置 ①.找到工作菜单 ②.依次点进Window --> Preference --> Java->Code Style --> Code Template(或直接查找Code Template) ③.点进Comments,按照下面所列的依次设定自动注释模板 2.需要注释的元素说明 类型 说明 Files 文件 ...

Jeremy__Yuan的博客 1万+

Idea 设置方法注释模板 Idea 2021.2配置方法类注释模板

一、概述 1、在使用Eclipse开发的时候,已经介绍过如何使用Eclipse设置方法注释模板,现在切换到idea中来了,为了保持开发工作格式的统一,那么在idea中,如何来设置方法注释的模板呢。 2、因本人使用的idea版本是:2021.2 , 故本文将以2021.2为例,记录idea中如何设置方法注释模板。二、新建java文件模板配置步骤 1、新建java文件模板【方法一】: File --- Settings --- Editor --- File and C

HaHa_Sir的博客 1万+

IDEA类和方法注释模板设置

idea快速设置类和方法注释

wozuhani的博客 1427

IDEA中设置注释模板的方法

  IDEA中设置注释模板主要分为两个部分,分别是创建java文件时类的注释和方法的注释。   这里为大家详细介绍一下方法,按MyEclipse的风格设置(MyEclipse的请看:MyEclipse中设置注释模板的方法),大家可以根据自己的习惯生成自己喜欢的注释模板。效果如下: 一、设置类的注释模板 1、选择File→Settings→Editor→File and ...

dianluo4096的博客 4566

goland 设置注释模板

网上找了一些办法 都没有说到关键点: 梳理一下设置步骤如下,以及避免的坑。 新建文件自动加注释: Preferences | Editor | File and Code Templates 打开go File 在右侧输入模板,然后点击Apply; 对已有的方法或者文件添加注释: 1、Preferences | Editor | Live Templates 打开LiveTempl...

wzbwzh的专栏 1万+

IDEA注释模板的设置

关于IDEA注释模板的设置File -> Settings -> Editor -> Live Templates还有一种是分开编写注释模板,根据文件类型进行定义注释模板 File -> Settings -> Editor -> File and Code Templates File -> Settings -> Editor -> Liv...

Memory的博客 255
上一篇: MySQL慢查询日志总结
下一篇: hibernate4的dao基础工具类
switch513
博客等级 码龄15年 15粉丝 1原创
评论
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付:10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值