[java][11]生成JavaDoc文档
java小白的学习记录......
JavaDoc注释用来注释类、属性、方法等
能够从源码中抽取类、属性、方法等的注释，形成配套API帮助文档
一、命令行方式
1. d盘下，用笔记本建立AutoLion.java，代码如下
/*an auto lion class*//*JavaDoc--class*/
/**
*AutoLion class
*version 1.0 2018/3/4
*/
public class AutoLion {
/*JavaDoc--attributes*/
/** color*/
String color="yellow";
public void run(){
System.out.println("running");
}
/*JavaDoc--methods*/
/**
* return ball
* @return
*/
public String robBall(){
String ball="football";
return ball;
}
public String getColor(){
return color;
}
public String showLion(){
return "This is a "+getColor()+" lion";
}
}
2. 生成JavaDoc文档
先编译生成.class
再生成文档，用javadoc -d myhelp AutoLion.java
d 存放javaDoc文档的路径
myhelp 存放javaDoc文档的文件夹
AutoLion.java 生成谁的javaDoc文档
D盘多了个myhelp文件夹，里面一堆文件。目测AutoLion.html最有用，地址是 file:///D:/myhelp/AutoLion.html
二、myeclipse工具
1）右键项目，选择Export （就算只选AutoLion.java，也会为整个工程生成doc）
2）选择java下面的javadoc
javadoc command: 选择jdk的bin/javadoc.exe
destination: 生成文档的保存路径，可自由选择。
生成后，工程下多了个doc文件夹