包机制和JavaDoc生成文档

一、包机制

• 为了更好地组织类，Java提供了包机制，用于区别类名的命名空间。

• 包语句的语法格式为：

package pkg1[. pkg2[.pkg3...]];

• 一般利用公司域名倒置作为包名; www.baidu.com com.baidu.www

• 为了能够使用某一个包的成员，我们需要在Java程序中明确导入该包。使用"improt"语句可以完成此功能

import package1.[package2...].(classname|*);

包的本质就是一个文件夹

---

二、JavaDoc

• JavaDoc命令是用来生成自己API文档的

• 参数信息：

  • @author 作者名

  • @version 版本号

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

  • @param 参数名

  • @return 返回值情况

  • @throws 异常抛出情况

JDK8的API文档：Overview (Java Platform SE 8 ) (oracle.com)

• 生成自己API文档的Dos命令：javadoc UTF-8 -charset UTF-8 文件名.java

其中UTF-8 -charset UTF-8是防止乱码的，可以支持更多的中文内容

package com.baidu.www;
​
​
/**
 * @author 美少女刘铁锤
 * @version 1.0
 * @since 1.8
 */
public class Doc {
    String name;
​
    /**
     * @author 美少女刘铁锤
     * @param name
     * @return
     * @throws Exception
     */
    public String test(String name) throws Exception{
        return name;
    }
​
    //通过命令行 javadoc  文件名.java
    //通过idea生成doc Tools -> Generate JavaDoc... 具体看以下介绍
}

---

IDEA生成JavaDoc文件:

解释一哈： 选择是整个项目还是模块还是单个文件

文档输出路径

Locale 选择地区，这个决定了文档的语言，中文就是zh_CN

传入JavaDoc的参数，一般这样写 -encoding UTF-8 -charset UTF-8 -windowtitle "文档HTML页面标签的标题" -link Java Platform SE 7

具体步骤参考如何使用Intellij Idea生成JavaDoc文档_大海会笑的博客-CSDN博客

视频参考Java基础12：JavaDoc生成文档哔哩哔哩bilibili