Javadoc生成文档

 1 package com.lin.base;
 2 
 3 /**
 4  * @author Lin
 5  * @version 1.0
 6  * @since 11
 7  */
 8 public class Doc {
 9     String name;
10 
11     /**
12      *
13      * @param name
14      * @return
15      * @throws Exception
16      */
17     public String test(String name)throws Exception{
18         return name;
19 
20         //我是通过命令行 javadoc 参数 Java文件
21         //javadoc -encoding UTF-8 -charset UTF-8 Doc.java 限定中文编译
22         //学会查找使用IDEA生产Javadoc文档！   面向百度编程！
23 
24         //基础部分的一切知识，后面几乎每天都会用
25     }
26 }

使用DOS命令生成Javadoc文档

idea 生成javadoc文件（并解决Error running ‘Javadoc’: Cannot generate JavaDoc - JDK path is not specified or invalid）

首先，如果想要生成某个类的doc文件时，只需鼠标单击选中该类即可,如图所示

选中之后在上方导航栏找到Tools,如图所示，点击红框中的选项

打开之后如图所示

这里解释一下，第一个红框中，就是你选中的类的路径。第二个红框是生成javadoc文件的存放路径，可以自己选择。第三个红框就是选择地区，这个决定了文档语言，中文就是zh_CN。第四个红框就是传入javadoc的参数，一般这样写：-encoding UTF-8 -charset UTF-8 -windowtitle “文档HTML页面标签的标题” -link http://docs.Oracle.com/javase/7/docs/api。