eclipse中初探javadoc

以前看别人的代码，总是看到很多英文注释，每行都有一个*和空格，不知其意，今天重读 thinking in java 才知道那是javadoc，

所有的javadoc命令都只能出现在/**注释中出现，结束于*/。使用javadoc的方式主要有两种：嵌入HTML，或使用“文档标签”。独立的文档标签是一些以“@”字符开头的命令，且要置于注释行的最前（但是不算前导*）。而“行内文档标签”则可以出现在javadoc注释中的任何地方，它们也是以“@”字符开头，但要在花括号内。 – thinking in java Fouth Edition

下面主要介绍eclipse中如何使用javadoc

源代码如下：

package main;
/**
* @author DQ
* @version 1.0
* @since 1.0
* 这是主类Test
* 换行*/
public class Test {
/** 这是域
* 换行
*/
public int i;
char c;
/**
* 构造函数说明
*/
public Test()
{
}
/**这是方法
* 换行
* @param i a add
* @param j another add
* @return the result of two
*/
public int  f(int i,int j)
{
return i+j;
}
/**
*主方法
*/
public static void main(String[] args) {
// TODO Auto-generated method stub
}
}

下面开始设置Javadoc ,打开Project->Generate Javadoc



选择javadoc.exe所在的目录、成员的可见性和输出目录。



单击Next，跳转到下图所示，选择需要产生的javadoc文档元素。



单击Next，跳转到下图所示，在该对话框内可以在文本区域内设置Javadoc的参数。



例如：如果出现中文乱码问题可以在此文本框输入命令：

-encoding UTF-8 -charset UTF-8

单击Finish，完成对Javadoc的创建。

效果如下图所示：