在Eclipse中设置自动生成注释

亦凉 2022-06-07 10:49 148阅读 0赞

转自：https://jingyan.baidu.com/article/a501d80c09dab1ec620f5e4b.html

对于开发的朋友，每次写类文件前面写注释文件，未免有些许重复，下面我们利用代码模板快速常见注释文件

## 工具/原料    ##

*  Eclipse

## 方法/步骤    ##

1.  1
    
    先看默认状态的吧，新建类文件时，是不生成注释的
    
    [![在Eclipse中设置自动生成注释][Eclipse]][Eclipse_Eclipse]
2.  2
    
    在
    
    windows-->preferenceJava-->Code Style-->Code Templatescode-->new Java file
    
    编辑文件为7的样式，（为了方便起见，中间分布截图说明，熟悉的朋友直接跳到7）
3.  3
    
    对于中文版本
    
    窗口-->首选项
    
    java-->代码样式-->代码模板
    
    代码-->新的java文件
4.  4
    
    菜单栏，窗口——首选项
    
    [![在Eclipse中设置自动生成注释][Eclipse 1]][Eclipse_Eclipse 1]
5.  5
    
    找到java选项-->代码样式
    
    [![在Eclipse中设置自动生成注释][Eclipse 2]][Eclipse_Eclipse 2]
6.  6
    
    注释-->新生成的java文件
    
    [![在Eclipse中设置自动生成注释][Eclipse 3]][Eclipse_Eclipse 3]
7.  7
    
    直接编辑配置文件
    
    在配置文件中间添加注释代码，这部分可以自定义，参考如下，关键字解释见后文10
    
    \------------------我是分割线，别复制我-----------------------------------
    
    $\{filecomment\}$\{package\_declaration\}/\*\* \* @author  作者 E-mail: \* @date 创建时间：$\{date\} $\{time\} \* @version 1.0 \* @parameter  \* @since  \* @return  \*/$\{typecomment\}$\{type\_declaration\}
    
    \------------------我是分割线，别复制我-----------------------------------
8.  8
    
    现在新建文件将自动生成注释
    
    [![在Eclipse中设置自动生成注释][Eclipse 4]][Eclipse_Eclipse 4]
9.  9
    
    补充说明;
    
    也许你看到我们在写注释文件时用到了很多关键字，那么这里我们就了解一下Javadoc
    
    **Javadoc**是Sun公司提供的一个技术，它从程序源代码中抽取类、方法、成员等注释形成一个和源代码配套的API帮助文档。也就是说，只要在编写程序时以一套特定的标签作注释，在程序编写完成后，通过Javadoc就可以同时形成程序的开发文档了
10. 10
    
    **关键词列表：**
    
    @author 作者名
    
    @date 日期
    
    @version 版本标识
    
    @parameter 参数及其意义
    
    @since 最早使用该方法/类/接口的JDK版本
    
    @return 返回值
    
    @throws 异常类及抛出条件
    
    @deprecated 引起不推荐使用的警告
    
    @see reference 查看引用
    
    @override 重写
    
    更多Javadoc用法可以访问：百度百科、官方文档。

[Eclipse]: https://imgsa.baidu.com/exp/w=500/sign=be1b7c2ccfbf6c81f7372ce88c3fb1d7/d53f8794a4c27d1ef082a38018d5ad6edcc438c9.jpg
[Eclipse_Eclipse]: /images/20220607/330bcb74e6b14030b4030e4d7ff570bc.png
[Eclipse 1]: https://imgsa.baidu.com/exp/w=500/sign=34ee566d8518367aad897fdd1e728b68/279759ee3d6d55fb3644ed626e224f4a21a4ddf0.jpg
[Eclipse_Eclipse 1]: /images/20220607/cf1ec3918c374ec19ac36a38cd8a77d0.png
[Eclipse 2]: https://imgsa.baidu.com/exp/w=500/sign=fae188e35aee3d6d22c687cb73176d41/37d3d539b6003af3915b4724362ac65c1138b695.jpg
[Eclipse_Eclipse 2]: /images/20220607/24aee2dd51ca40118ab1a63bbae0d5e2.png
[Eclipse 3]: https://imgsa.baidu.com/exp/w=500/sign=b514b0638982b9013dadc333438ca97e/10dfa9ec8a13632718385977928fa0ec09fac799.jpg
[Eclipse_Eclipse 3]: /images/20220607/03a52618632a48568209995bac4372d0.png
[Eclipse 4]: https://imgsa.baidu.com/exp/w=500/sign=2b49cb4c0fd79123e0e094749d355917/fcfaaf51f3deb48f6d9d3a9af31f3a292cf578fa.jpg
[Eclipse_Eclipse 4]: /images/20220607/40b0202914a54d02abbdde7db3ae2d74.png