Ecplise 文档注释及生成

在类或方法的开头 /** + Enter(回车)，注意 /* + 回车 属于 多行注释，两者是不同的

它会被 javadoc.exe 用以生成网页版的文档说明书。

我以前一直以为是公司专门找写网页的人写的呢，原来如此!

事例：

package com.jing.sum;

/**
 * 我的工具类
 * 
 * @author liujing
 * @version 1.0.0 版本
 */
public class Tool {

  /**
   * 该函数返回两个整数的和
   * 
   * @param num1
   *            第一个数
   * @param num2
   *            第二个数
   * @return 返回累加的和
   */
  public static int getSum(int num1, int num2) {
    return num1 + num2;
  }
}      

导出为Java文档说明书步骤：

1）选中想导出的文件项目

2）右键 Export... >> Java >> Javadoc >> 点 Next >> 

这时弹出的对话框要注意了：

如果 Javadoc command 的配置为空就要自己选择一下当时的安装JDK的路径了

我的是D:\Program Files\Java\jdk1.8.0_131\bin\javadoc.exe

选择自己想生成的项目包或文件

也可以选择自己想输出的目录

这时可以 点 Finish了

控制台输出：

<terminated> Javadoc Generation

正在构造 Javadoc 信息...
标准 Doclet 版本 1.8.0_131
正在构建所有程序包和类的树...
正在生成D:\workspace\helloworld\doc\com\jing\sum\Tool.html...
正在生成D:\workspace\helloworld\doc\com\jing\sum\package-frame.html...
正在生成D:\workspace\helloworld\doc\com\jing\sum\package-summary.html...
正在生成D:\workspace\helloworld\doc\com\jing\sum\package-tree.html...
正在生成D:\workspace\helloworld\doc\constant-values.html...
正在生成D:\workspace\helloworld\doc\com\jing\sum\class-use\Tool.html...
正在生成D:\workspace\helloworld\doc\com\jing\sum\package-use.html...
正在构建所有程序包和类的索引...
正在生成D:\workspace\helloworld\doc\overview-tree.html...
正在生成D:\workspace\helloworld\doc\index-files\index-1.html...
正在生成D:\workspace\helloworld\doc\index-files\index-2.html...
正在生成D:\workspace\helloworld\doc\index-files\index-3.html...
正在生成D:\workspace\helloworld\doc\deprecated-list.html...
正在构建所有类的索引...
正在生成D:\workspace\helloworld\doc\allclasses-frame.html...
正在生成D:\workspace\helloworld\doc\allclasses-noframe.html...
正在生成D:\workspace\helloworld\doc\index.html...
正在生成D:\workspace\helloworld\doc\help-doc.html...      

这时就可以到自己当时选定的目录去查看该文档说明书了，它是一份网页版的说明书。

一般网页都是由 index.html 为入口进入。