在Eclipse中生成javadoc

在《thinking in java》一书的第一章提到javadoc,以前也看过,每次看到这部就跳过了,没有真正去尝试过什么样子,今天终于亲自实践了一下,原来真的挺简单:
一、编写java源文件
package com.cn.ibm.javadocTestPac;

/**
 * @author Karen
 * @see HelloWorld 
 * @version 4.0
 */
public class JavadocTestClass {

    /**
     * @param args
     */
    public static void main(String[] args) {
        // TODO Auto-generated method stub
        System.out.println("javadocTestClass");
    }

}
二、
使用eclipse生成文档(javadoc)
主要有三种方法: 
1,在项目列表中按右键,选择Export(导出),然后在Export(导出)对话框中选择java下的javadoc,提交到下一步。
在Javadoc Generation对话框中有两个地方要注意的:
javadoc command:应该选择jdk的bin/javadoc.exe
destination:为生成文档的保存路径,可自由选择
按finish(完成)提交即可开始生成文档。
2,用菜单选择:File->Export(文件->导出),
剩下的步骤和第一种方法是一样的。
3,选中要生成文档的项目,然后用菜单选择,
Project->Generate Javadoc直接进入Javadoc Generation对话框,剩余的步骤就和第一种方法在Javadoc Generation对话框开始是一样的。

三、结果:生成一个按包目录的一些文件夹,并且生成JavadocTestClass.html等其他html文件



小结:使用javadoc主要还是靠自己在java源文件当中添加注释(这些注释要按照javadoc的规范书写),注释按规范写好了之后,并且用eclipse中自带的功能生产一个html文档,里面就有所注释所在类的详细信息。


原文地址:https://www.cnblogs.com/smilehuanxiao/p/javadoc.html