Java基础语法4：包机制、JavaDoc

Java基础语法4：包机制、JavaDoc

包机制

1. 为了更好的组织类，Java提供了包机制，用于区别类名的命名空间。
2. 包的本质就是文件夹
3. 包语句的语法格式为：

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

4. 一般利用公司域名倒置作为包名；

   • 例如www.baidu.com的包为com.baidu.www

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

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

6. import package1[.package2...].classname|*
   • 其中*为导入这个包下所有的类，通配符
   • 推荐看一本书《阿里巴巴Java开发手册》
   • 一定要认真看一下这本书，里面都是基础

JavaDoc

1. javadoc命令是用来生成自己API文档的
2. 参数信息
   • @author作者名
   • @version版本号
   • @since指明需要最早使用的jdk版本
   • @param参数名
   • @return返回值情况
   • throws异常抛出情况
3. 创建一个简单的类：例如Doc
4. 加在类上的注释为类的注释
5. 在方法上的注释为类的注释
6. 下面创建一个简单的文档架构

package com.song.base;

//类的注释
/**
 * @author  song //作者
 * @version 2.0 //版本
 * @since 1.8 //指明需要最早使用的jdk版本
 */

public class Doc {
    //随便定义一个变量
    String name;//属性

    //方法的注释
    /**
     * @author song //作者
     * @param name //参数名
     * @return  //返回值情况
     * @throws Exception  抛出异常
     */

    public String test(String name) throws Exception {
        return name;//方法

    }
    }

7. 然后使用IDEA生成Javadoc文档

使用IDEA生成文档的方法

方法一

1. 右击Doc -----> 点击 Open In Explorer找到文档所在位置

   

2. 在打开路径页面上选中路径，输入cmd+回车

   • 然后打开该文档位置的doc指令

   

3. 输入命令Javadoc -encoding UTF-8 -charset UTF-8 Doc.java回车

   

4. 然后原文档的文件夹里会生成很多新的东西

   

5. 主要找到index.html（主页），然后双击就会生成文档

   

方法二

1. （选中要生成文档的类）找到工具栏tools --> Gencrate JavaDoc…打开

   

2. 在弹出的窗口主要进行三步

   • 第一步：点击第三个：文档所在的位置
   • 第二步：输入语言环境为中文：zn_CN
   • 第三步：输入命令行参数: -encoding UTF-8 -charset UTF-8

   

3. 然后点击Generate（生成）生成文档

   

4. 最后在生成的com文件夹里找到index.html（主页），然后双击就会生成文档

   

   

标签：注释,Java,name,JavaDoc,生成,语法,文档,com
来源： https://www.cnblogs.com/sunyusong/p/16504215.html