Java基础语法重点06（java Doc生成文档）

JDK文档

（jdk文档中提供了java中的各种技术的详细资料，以及jdk中提供的各种类的帮助说明）

• 跳转到Java帮助文档1

• 跳转到Java帮助文档2

参数信息

• @ author (作者名)
• @ version (版本号)
• @ since (指明需要最早使用的jdk版本)
• @ param (参数名)
• @ return (返回值情况)
• @ throws (异常抛出情况)

/**
 *@author  zhangyi  //加在类上面，即为类注释
 *@version 1.0
 *@since   1.8 
*/
public class Doc{
    String name;//属性

/**
 *@param name      //加在方法上面，即为方法注释
 *@return 
 *@throws Expection
*/                              //抛出异常
public String test(String name) throws Expection{
    return name;
  }
}

扩展：

• 找到类的地址

• 在命令行打开cmd

• 输入：javadoc -encoding UTF-8 -charset UTF-8 Doc.java
  

• 会看见文件夹下面多了一堆东西，其中有index.html(首页)，

​ 点开

• 会看见其生成的文档信息，非常详细
  

---

每日分享：

生活从来都是泥沙俱下，鲜花与荆棘并存