19.JavaDoc

JavaDoc

• javadoc命令是用来生成自己API文档的（帮助文档）
• 参数信息
  • @author作者名
  • @version版本号
  • @since指明需要最早使用的jdk版本
  • @param参数名
  • @return返回值情况
  • @throws异常抛出情况

package com.yuxi.base;
/*
*@author xiaoyuzi
* @version 1.0
* @since 1.5
*  */
public class Doc {String name;//这是一个属性/*** * @param name* @return* @throws Exception*/public String test(String name) throws Exception{//9-11是一个方法return name;}}

学会使用IDEA生成JavaDoc文件

可以直接用工具生成JavaDoc文件