包机制与JavaDoc生成文档

包机制与JavaDoc生成文档

包机制

1. 语法格式：

pacckage pkg1[. pkg2[. pkg3...]];

1. 一般用公司域名倒置作为包名 例如com.baidu.www

2. 为了能够使用某一个包的成员，我们需要在java程序中明确导入该包，使用“import语句可以完成此功能

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

   JavaDoc

   1. JDKdoc命令是用来生成自己API文档的

   2. 参数信息

   。@author 作者名

   。@version 版本号

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

   。 @param 参数名

   。 @return 返回值情况

   。 @throws 异常抛出情况

package com.deng.base;
​
/**
 * @author zhangsan
 * @version 1.0
 * @since  1.8
 */
public class Doc {
​
    String name;
​
    /**
     * @author zhangsan
     * @param name
     * @return
     * @throws  Exception
     */
    public String test(String name) throws Exception {
        return name;
           //通过命令行 javadoc参数 Java文件
    }
}
​

作业：学会查找使用IDEA生产JavaDoc文档！ 面向百度编程

1. 在桌面创建一个名为JavaDoc的文件夹

2. 打开IDEA---> 点击工具-----> 选择生成JavaDoc

1. 点击JavaDoc打开---->点击输出目录选择桌面创建JavaDoc的文件夹的位置

2. 区域设置：zh_CN

3. 其他命令参数行：-encoding utf-8 -charset utf-8

4. 点击完成，运行成功