java文档注释模板_Javadoc&Eclipse注释模板CodeTemplate

在Eclipse中可按照自定义的模板自动生成注释文档。以下介绍注释模板的导入与修改及其效果。

1.下载模板

2.导入模板

Windows-->Preferences

导入.xml模板

也可在eclipse中直接写入模板

直接写入模板类模板Types如下/**

* Description:
 * @author ${user}* @version 1.0

* @Note

* ProjectName: ${project_name}

* PackageName: ${package_name}

* ClassName: ${type_name}

* Date: ${date} ${time}

*/方法模板Methods如下/**

* Description:
 * ${tags}

* @Note

* Author: LuoQ* Date: ${date} ${time}

* Version: 1.0

*/

我主要编辑了这两个模板，其他可根据以上模板自行定义。

3.生成注释及注释效果

自动生成注释

为类注释添加解释性文字

为方法注释添加解释性文字

4.导出javadoc

导出javadoc

配置javadoc相关信息

自定义标签-encoding UTF-8 -charset UTF-8 -tag Note:a:"Note:"

javadoc路径

javadoc目录

5.效果

效果1

效果2

6.修改模板

方法一

修改.xml配置文件

方法二

在Eclipse中修改模板根据上述方法进入References

在Eclipse修改模板

P.S.关于用户名问题

用户名相关

此处设置了点击用户名后进入超链接，也可将@author之后的一整串替换成简单的用户名，不设置超链接。

用${user}会根据电脑的用户名自动显示名称，有些用户会自动显示Administrator，修改user名称有以下两种方案在上图Eidt Template中将${user}改为自定义名称

在eclipse.ini配置文件中设置用户名

在eclipse安装目录下找到eclipse.ini

添加-Duser.name=自定义用户名，重启Eclipse

eclipse.ini关于“编码utf-8的不可映射字符” 问题

在eclipse中，Windows-->References

utf-8不可映射解决方案

前提：Configure javadoc arguments中添加了

-encoding UTF-8

-charset UTF-8

参考步骤4.导出javadoc

References

作者：LuoQ

链接：https://www.jianshu.com/p/03e62adec8e6