如何生成Doc说明文档及包机制

包机制

package basic;//这个是类文件所在包声明，必须要在第一行
//包的本质其实就是文件夹，方便区分，并且不同的包里可以出现同名的文件
import basic.Demo01;//这里是导入basic包里的Demo1类，就能在此项目中使用Demo1了
import basic.*; //星号是通配符，意思是导入这个包的全部类文件
import java.util.Date;

public class packrules {
    //包机制
    //Date
    // Date方法是在java.util.Date路径中，需要先导入这个包才能使用
    //给包取名要规范，新建包一般为公司域名倒置，例如com.baidu.www
    /*在项目右上角的设置键有一个CompactMiddlePackage选项，取消勾选。
    这样在新建包的时候可以采用例如lin.zhihao，这样生成的会是两个包，
    并且zhihao这个包是包含在lin这个包里的。*/
}

java生成Doc说明文档

package basic;

/**
 * @author 林志豪
 * @version 1.0
 * @since 1.8
 */

public class Doc {

    String name;//这是一个属性

    /**
     *
     * @param name
     * @return
     */      //这里输入/**回车就会自动生成参数param

    public String test(String name){
        return name;
    }//这里是一个方法

    //通过命令行输出javaDoc说明文档的方法：
    // javadoc加编码格式（-encoding UTF-8 charset UTF-8）再加文件名
    //cmd命令可以直接打开文件夹，然后在路径栏最前面输入cmd空格

    //通过IDEA生成jacadoc说明文档的方法：
    //最上方，点击Tools栏，有个Generate JavaDoc，
    //点击，然后选择生成的Doc文档存放路径，
    // Locale框中填zh_CN;  Other command line argument框中填编码格式（上有）

}