Java API文档

javadoc命令是用来生成自己的API文档的

参数信息

@author 作者名

@version 版本号

@since 指明需要最早使用的jdk版本

@param 参数名

@return 返回值情况

@throws 异常抛出情况

Java的API文档

选择对应jdk版本

cmd生成自己的API文档

1、代码演示

 1 package com.jiemyx.base;
 2 
 3 /**
 4 
 5  * @author jiemyx
 6 
 7  * @version 1.0
 8 
 9  * @since 1.8
10 
11  */
12 
13 public class Doc {
14 
15     String name;
16 
17     //代码写完，输入/**，回车，会自动生成
18 
19     /**
20 
21      * @author jiemyx
22 
23      * @param name
24 
25      * @return
26 
27      * @throws Exception
28 
29      */
30 
31     public String test(String name) throws Exception{
32 
33         return name;
34 
35     }
36 
37 }