JAVA学习(包机制、JavaDoc )

6、包机制、JavaDoc

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

  • 包语句的语法格式为:

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

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

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

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

 

javadoc命令用来生成自己的API文档

  • 参数信息

    • @auther 作者名

    • @version 版本号

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

    • @param 参数名

    • @return 返回值情况

    • @throws 异常抛出情况

E:\代码\javaSE\基础语法\src\com\kuangshen\base>javadoc -encoding UTF-8 -charset UTF8 Doc.java

 

package com.kuangshen.base;

/**
 * @author kuangshen
 * @version 1.0
 * @since 1.7
 */
public class Doc {
    String name;
    /**
     * @author kuangshen
     * @param name
     * @return
     * @throws Exception
     */
    public String test(String name) throws Exception{
        return name;
    }
    public static void main(String[] args) {

    }
    //作业:学会通过idea生成JavaDoc文档!
}

 

idea生成HTML文档的方法:

第一步:

JAVA学习(包机制、JavaDoc )

 

 

第二步:

JAVA学习(包机制、JavaDoc )

  1. 选择是整个项目还是模块还是单个文件

  1. 文档输出路径

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

  1. 传入JavaDoc的参数,一般这样写 -encoding UTF-8 -charset UTF-8 -windowtitle "文档HTML页面标签的标题" -link http://docs.Oracle.com/javase/7/docs/api

 

 

上一篇:第139天学习打卡(Docker 发布自己的镜像 Docker网络)


下一篇:Linux 个人笔记,根据狂神说 视频总结