Eclipse中设置作者日期等Java注释模板

╰+哭是因爲堅強的太久メ 2022-03-06 13:52 225阅读 0赞

转载自：[https://jingyan.baidu.com/article/1612d500856cb1e20e1eeed5.html][https_jingyan.baidu.com_article_1612d500856cb1e20e1eeed5.html]

Eclipse作为JavaIDE（Integrated Development Environment,集成开发环境）,可以通过设置自动添加Javadoc注释信息，如@author 作者名、@version 版本标识、@date 日期等，在创建类或新增方法时会自动添加注释信息。关于java如何生成javadoc文档可参考下文。下面将会为大家介绍如何在Eclipse中设置Java注释模板。

4[Eclipse规范注释及注释文档的生成][Eclipse]

## 工具/原料 ##

*  Eclipse Oxygen Release (4.7.0)

## 方法/步骤 ##

1. 1
 
  首先介绍几个常用的注解：
 
 @author 作者名
 
 @date 日期
 
 @version 版本标识
 
 @parameter 参数及其意义
 
 @return 返回值
 
 @throws 异常类及抛出条件
 
 @deprecated 引起不推荐使用的警告
 
 @override 重写
 
 这个注解我们在java代码中经常可以看到。
2. 2
 
 设置注释模板的步骤：点击菜单栏上的Window -->Preferences-->Java-->Code Style -->Code Templates，对右侧Comments选项中具体的注释信息进行编辑即可。可勾选上自动添加注释信息，在生成java文件时便会自动生成注释，当然也可以手动插入注释。设置的界面如下：
 
 [![Eclipse中设置作者日期等Java注释模板][Eclipse_Java]][Eclipse_Java_Eclipse_Java]
3. 3
 
 点击Edit按钮，进入编辑页面，全部编辑完成后点击“Apply And Close”即可设置完成，并关闭设置页面。
 
 [![Eclipse中设置作者日期等Java注释模板][Eclipse_Java 1]][Eclipse_Java_Eclipse_Java 1]
 
 [![Eclipse中设置作者日期等Java注释模板][Eclipse_Java 2]][Eclipse_Java_Eclipse_Java 2]
4. 4
 
 下面介绍具体的Comment如何设置：
 
 1. 点击Comments下的Files可对整个Java文件进行注释：包括公司名称，版权所属，作者信息，日期等。
 
  
 
 /\*\*  
 
 \* Title: $\{file\_name\}  
 
 \* Description:  
 
 \* Copyright: Copyright (c) 2017  
 
 \* Company: www.baidudu.com  
 
 \* @author shenlan  
 
 \* @date $\{date\}  
 
 \* @version 1.0  
 
 \*/  
5. 5
 
 2. 点击Types对类进行注释：
 
  
 
 /\*\*  
 
 \* Title: $\{type\_name\}  
 
 \* Description:  
 
 \* @author shenlan  
 
 \* @date $\{date\}  
 
 \*/  
 
  
 
 3. 点击Fields对字段进行注释：
 
  
 
 /\*\* $\{field\}\*/  
 
  
 
 4. 点击Constructors对构造方法进行注释：
 
  
 
 /\*\*  
 
 \* Title:  
 
 \* Description:  
 
 \* $\{tags\}  
 
 \*/  
 
  
 
 5. 点击Methods对方法进行注释：
 
  
 
 /\*\*  
 
  
 
  \* Title: $\{enclosing\_method\}  
 
  
 
  \* Description:  
 
  
 
  \* $\{tags\}  
 
  
 
  \*/  
6. 6
 
 6. 点击Overriding Methods对重写方法进行注释：
 
  
 
 /\* (non-Javadoc)  
 
  
 
  \* Title: $\{enclosing\_method\}  
 
  
 
  \* Description:  
 
  
 
  \* $\{tags\}  
 
  
 
  \* $\{see\_to\_overridden\}  
 
  
 
  \*/
 
  
 
 7. Delegate methods对代表方法进行注释：
 
  
 
 /\*\*  
 
 \* $\{tags\}  
 
 \* $\{see\_to\_target\}  
 
 \*/
 
  
 
 8. Getters对get方法进行注释：
 
  
 
 /\*\*
 
  
 
  \* @return the $\{bare\_field\_name\}  
 
  
 
  \*/
 
  
 
 9. Setters对set方法进行注释：
 
  
 
 /\*\*
 
  
 
  \* @param $\{param\} the $\{bare\_field\_name\} to set  
 
  
 
  \*/
7. 7
 
 注释模板的导入和导出：点击Import和Export按钮即可。
 
 [![Eclipse中设置作者日期等Java注释模板][Eclipse_Java 3]][Eclipse_Java_Eclipse_Java 3]
 
 END

## Java注释模板的使用 ##

1.  1
    
    在设置模板时如果勾选了自动添加注释信息，则在创建Java文件时会自动生成文档和类的注释信息，若没有勾选，按Shift+Alt+J快捷键也可生成。
    
    [![Eclipse中设置作者日期等Java注释模板][Eclipse_Java 4]][Eclipse_Java_Eclipse_Java 4]
2.  2
    
    在对类中的方法进行注释是：在方法上方输入/\*\* 后点击回车，即可生成方法注释；或将光标放在方法名上，按住Shift+Alt+J快捷键也可；或在方法上右击，source》Generate Element Comment也可生成注释。
    
    [![Eclipse中设置作者日期等Java注释模板][Eclipse_Java 5]][Eclipse_Java_Eclipse_Java 5]
    
    END

## 注意事项 ##

*  注释模板设置完一定要点击Appy保存

[https_jingyan.baidu.com_article_1612d500856cb1e20e1eeed5.html]: https://jingyan.baidu.com/article/1612d500856cb1e20e1eeed5.html
[Eclipse]: https://jingyan.baidu.com/article/597a064321af28312b5243b6.html
[Eclipse_Java]: https://imgsa.baidu.com/exp/w=500/sign=97da940ff1edab6474724dc0c734af81/29381f30e924b8999ad493fc64061d950b7bf60e.jpg
[Eclipse_Java_Eclipse_Java]: /images/20220303/60a1f0c96aec4199ab6f36b9e8001865.png
[Eclipse_Java 1]: https://imgsa.baidu.com/exp/w=500/sign=ff6f930488025aafd3327ecbcbecab8d/86d6277f9e2f07080644ffc4e324b899a801f2b5.jpg
[Eclipse_Java_Eclipse_Java 1]: /images/20220303/65812eca0c624d9c9ed664ad850ea393.png
[Eclipse_Java 2]: https://imgsa.baidu.com/exp/w=500/sign=6bd344fb41fbfbeddc59367f48f1f78e/060828381f30e92489e549f546086e061c95f7b5.jpg
[Eclipse_Java_Eclipse_Java 2]: /images/20220303/07c0a2e2ceaa4d15b630cd1da38fdce5.png
[Eclipse_Java 3]: https://imgsa.baidu.com/exp/w=500/sign=aa7399ead81b0ef46ce8985eedc651a1/78310a55b319ebc4b9f4a75d8826cffc1f171661.jpg
[Eclipse_Java_Eclipse_Java 3]: /images/20220303/254a2b1cffe541919150ac5dd9bb67b7.png
[Eclipse_Java 4]: https://imgsa.baidu.com/exp/w=500/sign=eee034b7a74bd11304cdb7326aaea488/b21c8701a18b87d6010a7bdb0d0828381e30fdae.jpg
[Eclipse_Java_Eclipse_Java 4]: /images/20220303/b0d6b3c3d4574d97a2132eff6df6f238.png
[Eclipse_Java 5]: https://imgsa.baidu.com/exp/w=500/sign=f81b461802fa513d51aa6cde0d6c554c/5ab5c9ea15ce36d3bcad50f430f33a87e850b14d.jpg
[Eclipse_Java_Eclipse_Java 5]: /images/20220303/4a9f56d071e4402d8506b94dfaa9ca78.png