包与Javadoc（六）

包与Javadoc（六）

创建包名规范

建议将公司域名或者项目的域名，倒序为包名，如：www.baidu.com的包名为com.baidu.www

在idea中选择src右键创建package，输入包名点击确定，比如我的是com.luca.jase,效果见图

如果在点击确定后，发现包名并没有层级显示，需要点击上面的齿轮，需要勾选Flatten Packages

Javadoc

package com.luca.jase;

//在类和方法上面输入/**回车即可生成文档注释，如下
/**
 * @author luca
 * @version 1.0
 */
public class Demo6 {
    static int age = 18;
    String name = "zhangsan";

    public static void main(String[] args) {
        Demo6 demo6 = new Demo6();
        System.out.println(demo6.name);
    }

    /**
     * @param age
     * @return age
     */
    public int add(int age) {
        return age;
    }
}

使用命令行生成javadoc

进入到文档所在路径，输入如下命令

javadoc -javafx src/com/luca/jase/Demo6.java  -encoding UTF-8 -charset UTF-8 -d src/com/luca/docs

即可在-d指定的路径中查看到新文件，用浏览器打开index.html查看，如下：

使用idea工具生成javadoc

1. 在工具栏Tools中选择Generate JavaDoc

2. 在弹出的窗口中进行配置（生成范围、输出位置、生成文档的等级、编码等）

3. 点击OK即可在指定的目录中查看javadoc