IDEA给【类】和【方法】设置作者和日期等注释（适合初学者）

野性酷女 2024-04-06 12:31 79阅读 0赞

**目录**

一：在Java类的开头自动注释作者名字和日期等信息

二：给Java的方法注释作者名字和日期等信息

1. 不可修改的模板：Postfix Completion

2. 可修改的模板：Live Templates

--------------------

**tips：**首先给大家推荐两款好用的免费软件：动图抓取软件：ScreenToGif和录屏工具：oCam，可用来作为日常的制作Gif和录屏，网盘链接：[夸克网盘分享][Link 1]

### **一：在Java类的开头自动注释作者名字和日期等信息** ###

> 这样以后只要我们创建一个类，就会自动显示作者名和日期时间等信息，便于记录！

**第一步：**File--->Settings--->Editor--->Code Style--->File and Code Templates

![89eb0d8eb5f14e1f990937b6c200ddf8.png][]

**第二步：**选择File Header，进行注释信息的设置

常用预设变量有：

![cb00e2d4f38a4d3f938de692348551b6.png][]

我们不妨写一个简单的注释信息：

/**
    *@Author：朗朗乾坤
    *@Package：${PACKAGE_NAME}
    *@Project：${PROJECT_NAME}
    *@name：${NAME}
    *@Date：${DATE}  ${TIME}
    *@Filename：${NAME}
    */

把注释信息直接拷贝进去![9893e7fddf4044e2bfd85104ebbe59bc.png][]

**第三步：**这样我们以后每次创建一个类，就会自动生成注释信息，效果展示：

![51cbcc53c46d4a6a828bddeb6df33c9c.png][]

### **二：给Java的方法注释作者名字和日期等信息** ###

> 在 IDEA 中，Postfix Completion有很多内置的编码模板，使用者只需要敲击简单的前缀即可生成代码；但是这些模板是固定的无法改变。鉴于 Postfix Completion 模板无法改变，IDEA 提供了 Live Templates 模板，该模板用户可以自定义。

#### 1. 不可修改的模板：Postfix Completion ####

File--->Settings--->Editor--->General--->Postfix Completion，里面有很多内置不可修改的模板

![90b14eb0b19f456eab555b4fb649751e.png][]

**例如：一些常用的模板 ；给定一个父类Animals，一个子类Bird，并且子类有一个特有的doOther()方法，创建对象animals和bird**

> （1）animals.arg 就等价于加了一个括号 (animals)
> 
> （2）animals.cast 就等价于强制类型转换 ((Bird) animals)
> 
> （3）animals.castvar 就等价于强制类型转换并赋值 Bird animals1 = (Bird) animals;
> 
> （4）inst 就等价于instance然后转型 if (bird instanceof Object) \{ Object o = (Object) bird; \}
> 
> （5）animals.inst 就等价于 animals instanceof Bird ? ((Bird) animals) : null;
> 
> （6）iter 就等价于 增强for循环 for (String arg : args) \{ \}
> 
> itar 就等价于 普通for循环
> 
> （7）animals.return 就等价于 return animals;
> 
> （8）souf 就等价于 System.out.printf("");
> 
> sout 就等价于 System.out.println();
> 
> soutv 就等价于 System.out.println("bird = " + bird);
> 
> （9）animals. null 和 ifn 就等价于 if (animals == null) \{ \}
> 
> （10）animals.notnull 和 animals.nn 就等价于if (animals != null) \{ \}
> 
> （11）list.for 生成list的for循环for (Object o : list) \{ \}
> 
> （12）psfs 就等价于 public static final String
> 
> （13）prsf 就等价于 private static final

#### 2. 可修改的模板：Live Templates ####

File--->Settings--->Editor--->Code Style--->Live Templates，里面有很多内置可修改的模板；我们可以进行修改已有的模板，也可以创建一个属于自己的模板

![83728e5c65d247e496f25f7177daeb5d.png][]

例如：创建一个注释模板，定义一个快捷键，这样以后只要我们，按下这个快捷键就会完成对方法的注释：

**第一步：**创建一个模板组：myTemplates

![fb1d8d26896940f7a2bc97d1c3b258bc.png][]

**第二步：**创建模板：mdes

![5d6de8f2456b462b8bbf6e70762a893b.png][]

在自定义模板中，可以通过 $名称$ 的形式声明变量，然后使用 内置的函数 为变量动态的赋值。

/**
    *@Date：$date$  // date变量下面会用内置函数进行赋值
    *@Author：
    *@return：
    *
    */

![6730530a0df34dbd906c5297e4da0d79.png][]

![149919c0c09d41599e7e0a0fa25363d2.png][]

**第三步：**点击Edit variables，使用 内置的函数date()为date变量动态的赋值

![a9f7971d98a548f3af01a60095b5d2a5.png][]

**第四步：**点击最下面的Define，设置模板的生效范围，分不清楚的话直接选Everywhere即可

![e1d052e412a74704af392b106441df30.png][]

**第五步：**这样以后给方法注释，先打出m就会有提示：

![4cda4b8193244b6b925079e8a8f5ac5a.png][]

然后回车就会自动生成注释信息：

![781a8e2b70244824acaeab8b1c12d443.png][]

[Link 1]: https://pan.quark.cn/s/15e9a38bda9a
[89eb0d8eb5f14e1f990937b6c200ddf8.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/06/8f9d0208b68a43b18659d9440be22994.png
[cb00e2d4f38a4d3f938de692348551b6.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/06/a3f6b8b8ed9e4186a7ffe5717abe9482.png
[9893e7fddf4044e2bfd85104ebbe59bc.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/06/cf8b61c7aaf646a2866c3b5358f6ba8b.png
[51cbcc53c46d4a6a828bddeb6df33c9c.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/06/61e278e80ed84e2b85f6b7cbf0880c60.png
[90b14eb0b19f456eab555b4fb649751e.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/06/966506646a7e48db831ba9990d9c6eb3.png
[83728e5c65d247e496f25f7177daeb5d.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/06/cbb5d0d9ab4a4df4a0e3b534fb82a634.png
[fb1d8d26896940f7a2bc97d1c3b258bc.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/06/74e5b309955e44e5a8dca288784f243c.png
[5d6de8f2456b462b8bbf6e70762a893b.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/06/b8acba72b78b4c90b4ab352571ded702.png
[6730530a0df34dbd906c5297e4da0d79.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/06/a3059a2bcbb5439a80d3555e076206dc.png
[149919c0c09d41599e7e0a0fa25363d2.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/06/6642ec6c32d14b68bcde1d958bba8521.png
[a9f7971d98a548f3af01a60095b5d2a5.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/06/9fe6e0ba0100416eb764b118a1055a92.png
[e1d052e412a74704af392b106441df30.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/06/1234a82e00a74b05b8884c62eb0f6bb7.png
[4cda4b8193244b6b925079e8a8f5ac5a.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/06/759e2b4928844570a782efee74d70fb0.png
[781a8e2b70244824acaeab8b1c12d443.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/06/980b23d3f0624e8d8c3fb245c8beccf8.png