包机制 javaDoc生成文档 怎样使用IDEA生成JavaDoc文档

包机制

一般利用公司域名倒置作为包名

eg:www.baidu.com 用com.baidu.www作为包名

导入包,用import

在包后面加*,可以导入包下所有类

javaDoc生成文档

https://docs.oracle.com/javase/B/docs/api/

可以在类上,也可在方法上

//类上
package com.vvv.www.base.operator.Base;

/**
 * @author  vvv
 * @version 1.0
 */
public class Doc {

        String name;
public class Doc {

        String name;
//方法上
    /**
     *
     * @param name
     * @return
     * @throws Exception
     */
    public String test(String name) throws Exception{
            return name;
    }
}

参数信息

@author 作者

@version 版本号

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

@param 参数名

@return 返回值情况

@throws 异常抛出情况

使用IDEA生成新文档

posted @ 2021-06-14 16:16  valder-  阅读(52)  评论(0)    收藏  举报