Java基础语法----6.包机制、JavaDoc

6、包机制、JavaDoc

包机制

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

• 包语句的语法格式：

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

• 一般利用公司域名倒置作为包名

  比如：www.baidu.com，在开发的时候，可以使用com.baidu.www方式作为包名，类似的有com.baidu.baike, com.baidu.wenku，这样使得包的管理更清晰。

• 为了能够使用某一个包的成员，我们需要在Java程序中明确导入该包。

  import package1[.package2...].(classname|*);
  
  import com.lding.*;		//导入com.lding下的所有包
  

JavaDoc

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

• 参数信息

  • @author 作者名
  • @version 版本号
  • @since 指明需要最早使用的jdk版本
  • @param 参数名
  • @return 返回值情况
  • @throws 异常抛出情况

  package com.lding.base;
  /**
   * @author lding
   * @version 1.0
   * @since 1.0
   */
  public class Doc {
      String name;
      /**
       * @author lding
       * @param name
       * @return
       * @throws Exception
       */
      public String test(String name) throws  Exception{
          return  name;
      }
  }
  

• 加在class内的注释，就是类注释；加在方法里的注释，就是方法注释。

• 生成JavaDoc文档:

  • JavaDoc是一种将注释生成HTML文档的技术，生成的HTML文档类似于Java的API，易读且清晰明了。

  • 通过命令行的方式，生成JavaDoc文档

  E:\java\JavaSE\基础语法\src\com\lding\base>javadoc -encoding UTF-8 -charset UTF-8 Doc.java
  正在加载源文件Doc.java...
  正在构造 Javadoc 信息...
  正在构建所有程序包和类的索引...
  标准 Doclet 版本 17.0.1+12-LTS-39
  正在构建所有程序包和类的树...
  正在生成.\com\lding\base\Doc.html...
  Doc.java:12: 警告: @param 没有说明
       * @param name
         ^
  Doc.java:13: 警告: @return 没有说明
       * @return
         ^
  Doc.java:14: 警告: @throws 没有说明
       * @throws Exception
         ^
  正在生成.\com\lding\base\package-summary.html...
  正在生成.\com\lding\base\package-tree.html...
  正在生成.\overview-tree.html...
  正在构建所有类的索引...
  正在生成.\allclasses-index.html...
  正在生成.\allpackages-index.html...
  正在生成.\index-all.html...
  正在生成.\index.html...
  正在生成.\help-doc.html...
  3 个警告
  

  • 通过IDEA生成JavaDoc文档

    IDEA–tools–generate JavaDoc–选择JavaDoc的范围、输出路径、命令行参数等，即可生成对应的JavaDoc文档。

    1.范围：选择是整个项目还是模块还是单个文件
    2.文档输出路径
    3.Locale： 选择地区，这个决定了文档的语言，中文就是zh_CN
    4.传入JavaDoc的参数：一般这样写 -encoding UTF-8 -charset UTF-8
    

  ------------------------------“笔记整理自跟着《狂神说Java》”----------------------------------​