包机制、JavaDoc生成文档

包机制

• 包的本质是文件夹
  

package com.joy.operator;

import com.joy.Base.Demo01;
import com.joy.Base.*; //通配符，全部导入

public class Demo01 {
    public static void main(String[] args) {
        //二元运算符
        //command+D：复制当前行到下一行
        int a = 10;
        int b = 20;
        int c = 25;
        int d = 25;

        System.out.println(a+b);
        System.out.println(a-b);
        System.out.println(a*b);
        System.out.println(a/(double)b); //否则int结果为0
    }
}

• import必须在package后面
• 第二个Demo01报错，尽量不同包里不用相同的类名
• 《阿里巴巴Java开发手册》，规范代码 百度云链接

JavaDoc

• Java API 在线帮助文档 （英文版）
• 中文版见电脑桌面ece- preparation
  

package com.joy.Base;

//给类加注释
/**
 * @author joyji
 * @version 1.0
 * @since 1.8
 */
public class Doc {
    //属性
    String name;

    //给方法加注释   param 参数   return 返回值

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

}

生成文档

从终端生成

cd /Users/joyji/Desktop/ECE/preparation/code/JavaSE/ 基础语法/src/com/joy/Base
javadoc -encoding UTF-8 -charset UTF-8 Doc.java

1. 在idea的左边目录右键，open in，finder
2. 查看简介，复制路径
3. 打开terminal，输入路径
4. javadoc 参数 java文件
5. 在文件夹点击index.html进行查看

从IDEA生成

首先选择需要生成文档的代码



-encoding utf-8 -charset utf-8