Java基础笔记5（包、JavaDoc）

包

  • 一般使用公司域名倒置作为包名，如

    • com.baidu.www
    • com.baidu.baike
    • com.baidu.blog

  • 包中的类要在类前面加上package 包名，如

    1
    package com.baudu.www	//注：要放在代码最上面

  • 导入其他包中的类时使用import，如

    1
    import java.util.*	//*表示导入该包下所有的类

JavaDoc

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

  • 参数

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

  • 如下：

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    package com.hollowshadow;

    /**
     * @author Haunt
     * @version 1.0
     * @since 1.8
     */
    public class Student {
        String name;

        /**
         * @author Haunt
         * @param s
         * @return void
         * @throws Exception
         */
        public void setName(String s) throws Exception {
            this.name = s;
        }
    }
    1
    2
    打开命令行，执行javadoc命令
    javadoc -encoding UTF-8 -charset UTF-8 Student.java
    • 打开类所在目录，发现自动生成html等文件，打开index.html，即javadoc生成的API文档

IDEA中使用JavaDoc

  1. 菜单 Tools -> Generate JavaDoc

  2. 进行配置

    • Generate JavaDoc scope：使用JavaDoc生成文档的范围

    • Output directory：生成的文档所在的目录

    • Locale：语言版本，默认英文或者是当前操作系统语言，zh_CN中文

    • Other command line arguments：参数设置，多个参数可用空格隔开。
      如：-encoding UTF-8 -charset UTF-8 -windowtitle “标题名” -link http://docs.oracle.com/javase/7/docs/api-encoding

      • -encoding UTF-8
        表示源代码基于 UTF-8 编码，避免非英语字符乱码问题

      • -charset UTF-8
        表示在处理并生成 JavaDoc 超文本时使用的字符集也是以 UTF-8 为编码

      • -windowtitle “标题名”
        表示生成的 JavaDoc 文档在浏览器中打开时，标题栏显示的内容

      • -link http://docs.oracle.com/javase/7/docs/api-encoding

        表示生成的 JavaDoc 中涉及到很多对其他外部 Java 类的引用，是使用全限定名称还是带有超链接的短名称，如

        1
        2
        3
        String s(带有超链接的短名称)
        //在生成 JavaDoc 时如果不指定 -link 参数，则JavaDoc中对该方法的表述就会自动变为 
        java.lang.String s(全限定名称)