Java自学笔记——基础语法（五）包机制、JavaDoc

Java基础语法目录

Java自学笔记——基础语法（一）注释、标识符、关键字
Java自学笔记——基础语法（二）数据类型、类型转换
Java自学笔记——基础语法（三）变量、常量
Java自学笔记——基础语法（四）运算符
Java自学笔记——基础语法（五）包机制、JavaDoc

一、包机制

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

• 包语句的语法格式为：

  package pkg1[ .pkg2[. pkg3…] ]；

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

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

  import package1 [ package2…(classname|*);

包的本质就是文件夹

import com.kuang.base.*;   //导入包下所有的类！

阿里巴巴 Java开发手册。 自己查
手册

二、JavaDoc

1. Java SE文档

在线 API帮助文档 Overview (Java Platform SE 8 ) (oracle.com)

javadoc命令是用来生成自己PAI文档

2. 参数信息

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

3. 生成Javadoc文档 1

package com.blue.base;

/**
 * @author blue
 * @version 1.0
 * @since 1.8
 */
public class Doc {

    String name;

    /**
     * @author blue
     * @param name
     * @return
     * @throws Exception
     */

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

    //我是用命令行生成   javadoc - encoding UTF-8 -charset UFT-8 Doc.java
    //作业：学会查找使用IDEA生成JavaDoc文档！   面向百度编程

}

命令 javadoc - encoding UTF-8 -charset UFT-8 Doc.java （UTF-8让中文显示更正常，Doc.java 编译成一份文档）

4. 生成Javadoc文档 2

以后自己再总结

生成JavaDoc文档