Java基础语法-文档注释JavaDoc

1.什么是java文档

java文档中描述了完整的包的结构，包中的类的信息，
类中的属性、方法，以及方法的参数，返回值，异常抛出等信息。
java文档是用来帮助我们能够快速的熟悉和使用一个陌生的类。

2.官方的java文档长什么样

下面是java8的官方文档的连接，可以点击查看一下
https://docs.oracle.com/javase/8/docs/api/

java8帮助文档 【可以直接点击打开连接】

3.如果要生成文档，我们要写的东西

@author : 作者名
@version : 版本号
@since : 指明需要使用的最低的jdk版本
@param : 方法上的参数名
@returns : 方法的返回值
@throws : 异常抛出情况

4.来，我们自己写一下

package com.northcastle.B;

/**
 * @author : NorthCastle
 * @version : v1.0
 * @since : jdk1.8
 */
public class TestJavaDoc {

    /**
     * 方法 ：
     * @param name ： 一个名字
     * @return ： 返回一个新的字符串
     * @throws Exception ： 抛出一个异常
     */
    public String sayHello(String name) throws Exception{
        String res = "Hello "+name;
        return res;
    }
}

5.下面使用命令行的方式生成java文档

1.新建一个目录用来存放生成的文档

D:\DDevWorkspace\workspaceJava\javadoc

2.打开命令行，执行以下命令

javadoc -encoding UTF-8 -charset UTF-8 
-d D:\DDevWorkspace\workspaceJava\javadoc 
D:\DDevWorkspace\workspaceJava\JavaBase\01-basic-grammer\src\com\northcastle\B\TestJavaDoc.java

可以通过 javadoc --help 命令查看各个参数的含义，不在赘述

3.查看生成的文档
进入到 D:\DDevWorkspace\workspaceJava\javadoc 目录下，发现已经生成了好多文件，打开index.html查看。

6.下面使用IDEA生成文档

在目标目录中可以看到对应的生成的文件，并且同样打开index.html即可查看文档

7.完成

Congratulations!
You are one step closer to success!