IDEA如何生成JavaDoc文档

1、准备需要生成JavaDoc文档的类

?

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28

/**  * 测试生成JavaDoc文档  *  * @author xiaomaomao  * @version V1.0  * @since V1.0  */ public class TestGenerateDoc {     private Integer id;     private String message;     /**      * 发送消息的方法      * @param id 接收信息人唯一标识      * @param fileName 文件名称      * @return sendOK 返回是否发送成功      * @throws FileNotFoundException 可能出出现文件不存在异常      */     public Boolean sendMessage(Integer id, String fileName) throws FileNotFoundException {         Boolean sendOk = false;         FileInputStream inputStream = new FileInputStream(fileName);         String message = inputStream.toString();         if (message != null) {             System.out.println("I will send message to" + id + "and the message content is" + message);             sendOk = true;         }         return sendOk;     } }

　　

2、tools---->GenerateJavaDoc---->可以看到如下界面:

　　Generate JavaDoc scope:选择你需要生成JavaDoc文档的内容,我这里只需要将TestGenerateDoc.java这个类生成文档.

　　Output directory:生成的JavaDoc文档会存放在哪里.

　　Locale:zh_CN

　　Other command line arguments:

　　　　-encoding UTF-8 -charset UTF-8 -author -version -windowtitle "TestGenerateDocV1.0"    

　　　　注意参数里面的TestGenerateDocV1.0就是你生成的JavaDoc存放的指定目录

 

3、点击OK便可以生成JavaDoc文档

 

4、生成的JavaDoc文档如下: