IDEA 文件方法注释和版权配置指南

博主：情天
发布时间：2024 年 07 月 18 日
2328 次浏览
4 条评论
2985字数
分类：笔记

# IDEA 文件方法注释和版权配置指南

效果图:

![image](https://pic.ixleo.com:9981/pic/sy/note/image-20240718223449-2l5fsjf.png)

![image](https://pic.ixleo.com:9981/pic/sy/note/image-20240718223700-hubpas2.png)

# 配置文件注释模板

1. 启动 IntelliJ IDEA 并打开你的项目。
2. 导航到 `File` 菜单，选择 `Settings`（对于 Mac 用户，请选择 `Preferences`）。
3. 在设置窗口中，展开 `Editor`，然后选择 `File and Code Templates`。
4. 在 `Includes` 选项卡中，选择 `File Header`。

## 示例文件头模板

你可以在 `File Header` 中添加以下示例模板：

```java
/**
* @ClassName: ${NAME}.java
* @Author: 情天
* @Email: ixleo@ixleo.com
* @Date: ${DATE} ${TIME}
* @Version: V1.0
* @Description: TODO
*/
```

* `${NAME}`: 文件名
* `${DATE}`: 当前日期
* `${TIME}`: 当前时间
* `${PROJECT_NAME}`: 项目名称
* `${PACKAGE_NAME}`: 包名

![image](https://pic.ixleo.com:9981/pic/sy/note/image-20240718224257-64c4gt8.png)

# 配置方法注释

1. 在设置窗口中，展开 `Editor`，然后选择 `Live Templates`。
2. 点击 `+` 号添加一个新的模板组，并为其命名，例如 `Method Comments`。
3. 在新建的模板组上再次点击 `+` 号，选择 `Live Template`，然后为模板命名，例如 `Method Comment`。

模板内容:

`缩写`: ** (两个 * 号优化触发逻辑)

`描述`: 自定义

`模板文本`: 如下

```sql
**
 * @author 情天
 * @date $date$ $time$
$param$
 * @return $return$
 * @description TODO
 */
```

![image](https://pic.ixleo.com:9981/pic/sy/note/image-20240718224938-b0bpchu.png)

`模板变量`: 如下

```text
date: date()
time: time()
param: groovyScript("def result=''; def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList(); def types=\"${_2}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList(); for(i = 0; i < params.size(); i++) {result+=' * @param ' + params[i] + ' ' + \"{@link \"+types[i]+\"}\" + ((i < params.size() - 1) ? '\\r\\n' : '')}; return result", methodParameters(), methodParameterTypes())
return: groovyScript("def result=\"${_1}\"; if(result == \"void\"){return \"\";}else{return \"{@link \"+result+\"}\";}", methodReturnType())
```

![image](https://pic.ixleo.com:9981/pic/sy/note/image-20240718225202-tzgrmp4.png)

最后要选择模板适用的位置

![image](https://pic.ixleo.com:9981/pic/sy/note/image-20240718225340-j9guotd.png)

`默认方式`: 选择 <kbd>Enter</kbd>, 即在方法上输入 `/**` 再按一下回车即可触发, 由于触发路径为 `**` + <kbd>Enter</kbd> 所以不影响 单 `*` 的多行注释

1. 在设置窗口中，导航到 `Editor` -\> `Copyright`。
2. 在 `Copyright Profiles` 下，点击 `+` 号创建一个新的版权配置文件，并为其命名。
3. 在右侧的文本框中输入你的版权声明，例如：

```text
Copyright (c) 2020-$today.year 情天 All rights reserved.
Organization 星闪 stars.ixleo.com
Author 情天(ixleo@ixleo.com)
Motto Always believe that good things are about to happen
Last modified time $file.lastModified.format("yyyy-MM-dd HH:mm:ss")
```

* `$today.year`: 当前年份
* `$file.lastModified.format("yyyy-MM-dd HH:mm:ss")`: 文件最后修改时间

‍

最后修改：2024 年 07 月 18 日