Java十五：JavaDoc生成文档

JavaDoc生成文档

一、在IDEA中书写文本注释

• @author nanxu 作者名
• @version 1.0 版本号
• @since 1.8 指明需要最早使用的JDK版本
• @param name 参数名
• @return 返回值情况
• @throws Exception 异常抛出情况

package com.kuangstudy.Base;

//一、类上面的文本注释
/**
 * @author nanxu        
 * @version 1.0         
 * @since 1.8           
 */

public class Doc {    
    int age; 
    
  //二、加在方法上的文本注释    
    /**                        在这里输入  /** 回车，就直接生成下面的内容
     *
     * @param name              
     * @return                  
     * @throws Exception        
     */
    public String test(String name) throws Exception{    
        return name;
    }    
}

二、通过cmd终端来生成相应的文档

1. 通过Show in Explorer进入该文件所在的文件夹，并在该文件下进入cmd终端

2. 在cmd中输入：javadoc -encoding UTF-8 -charset UTF-8 J7_Doc.java，回车

3. 在目录文件夹下生成相应的文档

   

4. 打开索引文件后，在网页上显示的效果

​

三、使用IDEA 生成JavaDoc文档

1. 在菜单栏Tools中打开Generate JavaDoc

   

2. 按下图完成相应的配置，在command line arguments中输入如下的参数
   -encoding UTF-8 -charset UTF-8 -windowtitle “poi导出配置” -link http://docs.Oracles.com/javase/7/docs/api

   

3. 生成了相应的文档

   

备注：
以上均为本人的听课笔记
点此进入遇见狂神说Java视频教学，满满干货，良心开源教学，超赞，中国程序员楷模