Javadoc&Eclipse注释模板CodeTemplate

Java工具

浏览数:1,493

2019-1-24

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

1.下载模板

codetemplates

2.导入模板

也可在eclipse中直接写入模板

  • 类模板Types如下
/**
* <b>Description:</b><br> 
* @author <a href="http://www.jianshu.com/users/1bda2d4550e2/latest_articles" target="_blank">${user}</a>
* @version 1.0
* @Note
* <b>ProjectName:</b> ${project_name}
* <br><b>PackageName:</b> ${package_name}
* <br><b>ClassName:</b> ${type_name}
* <br><b>Date:</b> ${date} ${time}
*/
  • 方法模板Methods如下
/**
* <b>Description:</b><br> 
* ${tags}
* @Note
* <b>Author:</b> <a href="http://www.jianshu.com/users/1bda2d4550e2/latest_articles" target="_blank">LuoQ</a>
* <br><b>Date:</b> ${date} ${time}
* <br><b>Version:</b> 1.0
*/

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

3.生成注释及注释效果

4.导出javadoc

-encoding UTF-8 
-charset UTF-8 
-tag Note:a:"Note:"

5.效果

6.修改模板

方法一

修改.xml配置文件

方法二

在Eclipse中修改模板

  • 根据上述方法进入References

P.S.

  • 关于用户名问题

此处设置了点击用户名后进入超链接,也可将@author之后的一整串替换成简单的用户名,不设置超链接。
用${user}会根据电脑的用户名自动显示名称,有些用户会自动显示Administrator,修改user名称有以下两种方案

  1. 在上图Eidt Template中将${user}改为自定义名称
  2. 在eclipse.ini配置文件中设置用户名

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

  • 关于“编码utf-8的不可映射字符” 问题
    在eclipse中,Windows–>References

    前提:Configure javadoc arguments中添加了
    -encoding UTF-8
    -charset UTF-8
    参考步骤4.导出javadoc

References

1.Javadoc详细用法.pdf (来源:百度文库)
2.javadoc 生成自定义的标签
3.Javadoc转换chm帮助文档的四种方法总结
4.自定义JavaDoc注解和代码模版

Time:* 2016.07.05 *

原文地址:https://www.jianshu.com/p/03e62adec8e6