Idea使用笔记——自定注释模板&自定义代码模板&自定义File and Code Templates

最新推荐文章于 2024-11-23 00:11:48 发布

原创最新推荐文章于 2024-11-23 00:11:48 发布 · 3.5k 阅读

12 ·

CC 4.0 BY-SA版权

java开发笔记专栏收录该内容

71 篇文章

订阅专栏

本文详细介绍如何在IntelliJ IDEA中自定义类和方法的注释模板，包括设置步骤、模板示例及自定义快捷方式，帮助提高代码规范性和效率。

设置类注释：

File-->settings-->Editor-->File and Code Templates-->Files

类注释模板：

/**
 * @Classname ${NAME}
 * @Description TODO
 * @author ${USER}
 * @Date ${DATE} ${TIME}
 * @Version V1.0
 */

（1）${NAME}：设置类名，与下面的${NAME}一样才能获取到创建的类名

（2）TODO：代办事项的标记，一般生成类或方法都需要添加描述

（3）${USER}、${DATE}、${TIME}：设置创建类的用户、创建的日期和时间，这些事IDEA内置的方法，还有一些其他的方法在绿色框标注的位置，比如你想添加项目名则可以使用${PROJECT_NAME}

自定义快捷方式：

File-->Settings-->Editor-->Live Templates

添加模板：

参考这两篇文章：

https://www.jianshu.com/p/3dac8317c687

https://blog.youkuaiyun.com/xiaoliulang0324/article/details/79030752

不错的模板：

类

/**
 * <p>项目名称: ${project_name} </p> 
 * <p>文件名称: ${file_name} </p> 
 * <p>描述: [类型描述] </p>
 * <p>创建时间: ${date} </p>
 * <p>公司信息: ************公司 *********部</p> 
 * @author <a href="mail to: *******@******.com" rel="nofollow">作者</a>
 * @version v1.0
 * @update [序号][日期YYYY-MM-DD] [更改人姓名][变更描述]
 */

方法：

/**
 * @Title：${enclosing_method}
 * @Description: [功能描述]
 * @Param: ${tags}
 * @Return: ${return_type}
 * @author <a href="mail to: *******@******.com" rel="nofollow">作者</a>
 * @CreateDate: ${date} ${time}</p> 
 * @update: [序号][日期YYYY-MM-DD] [更改人姓名][变更描述]     
 */