JavaDoc生成文档练习

最新推荐文章于 2024-10-10 09:56:47 发布

猫咪小鱼干233

最新推荐文章于 2024-10-10 09:56:47 发布

阅读量43

点赞数

文章标签： java spring 开发语言学习方法

本文链接：https://blog.csdn.net/palpitate233/article/details/129679900

版权

文章目录

JavaDoc
- - 参数信息
  - 操作过程

JavaDoc

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

参数信息

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

操作过程

创建一个Doc类

package src;

/**
 * @author FReeDOM
 * @version 1.0
 * @since 1.9
 */

//加在类上面就是类的注释
public class Doc {

    String name;

    /**
     * @author FReeDOM
     * @param name
     * @return
     * @throws Exception
     */

    //加在方法上面就是方法的注释
    public String  test(String name) throws Exception  {

        return name;

    }

}