包与Doc

X~ming / 2024-03-02 / 原文


package com.xming.www.operator;//当前文件所在包

import  java.util.Date;			//导入java包

import  com.xming.www.base.*	//表示将base包的类全部导入

包的命名一般按照域名的倒置


Doc


文档注释

package com.xming.www.operator;
//文档注释
/**
 * @author xming		
 * @version 1.0
 * @since 2.1
 */
public class javaDoc {

    /**
     * @author xming
     * @param name
     * @return
     * @throws Exception
     */
    String name;
    public String text(String name) throws Exception{
        return name;
    }
}

以上是对Doc的基本了解,下面是如何使用IDEA生产JAVADoc文档

详情见这篇文章:使用IDEA生成JavaDoc文档