存档

文章标签 ‘javadoc’

JavaDoc标签介绍

2009年3月12日 没有评论

Javadoc注释由Javadoc标签和描述性文本组成,你可以为类、接口添加注释,也可为构造函数、值域、方法等类中的元素添加注释。我们来看一个带Javadoc注释的程序,其代码如下所示
阅读全文...

分类: Java 标签: ,

Eclipse中设置方法注释模板并使用方法注释

2009年3月12日 没有评论

设置方法注释模板:选择eclipse菜单栏中【窗口】下的【首选项】,展开左边树到Java->代码样式->代码模板,展开右边出现的对话框中的注释->方法,点击右边的【编辑】按钮。编辑其中的内容。也可以点击下面的【插入变量】按钮添加变量。例如:
/**
*@author ${user}
*@功能:
*${tags}
*/

其中@author是JavaDoc的标示,带$符号的是变量。
使用时鼠标放置在需要添加注释的方法内部的任意位置。点击菜单栏中【源代码】下的【添加Javadoc注释】,或者使用快捷键Alt+Shift+J,则eclipse自动在该方法前面添加注释,例如public static void main(String[]args)生成如下注释:
/**
* @author a18ccms
* @功能:
* @param args
*/

当然添加完之后还需要手动添加其中的各项内容,如方法的功能和参数的含义等。

分类: Java 标签: , ,

在Eclipse中设置中文JavaDOC

2009年3月12日 没有评论

在Eclipse中,我们常常看一些英文的JavaDoc提示或者没有相应的提示是很不习惯的,如下图所示:
image
我们现在要把这种不习惯的提示改为中文的JavaDOC提示
阅读全文...

分类: Java 标签: , ,