第4天 JavaDoc生成文档&Java流程控制（第一节：用户交互Scanner）

JavaDoc生成文档

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

   参数信息：

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

package com.kuang.base;

/**
 * @author
 * @version
 * @since
 */
public class Doc {
    String name;

    /**
     *
     * @param name
     * @return
     */
    public  String test(String name){      //在上面直接输入/**  回车即可自动填写信息
        return name;
    }

    //老师通过命令行生成javadoc    javadoc              参数             Java 文件
                              //javadoc -encoding UTF-8 -charset UTF-8 Doc.java
    //作业：学会用IDEA生成JavaDoc文档     面向百度编程
    //基础部分的一切知识，后面每天都会用！！！！！
}

1. 官方的API文档：百度搜索jdk帮助文档 选择官方的网址，即可进入选择自己的版本 8得到下面网址

   ​ https://docs.oracle.com/javase/8/docs/api/

​

3.用DOS 生成一个javadoc 在java文件所在目录打开cmd，输入

​ javadoc -encoding UTF-8 -charset UTF-8 Doc.java

​ 打开index.html 即是他的首页

1. 用IDEA生成JavaDoc（引自：https://www.cnblogs.com/xiaoming0601/p/6657136.html）

• IDEA 的 JavaDoc 生成功能在菜单 Tools->Generate JavaDoc 项里面。

• 点击上述菜单项后，会出现生成 JavaDoc 的对话框，一般的选项都很直观，不必细说。但是要注意生成 JavaDoc 的源代码对象的选择，一般以模块（Module）为主，必要时可以单独选择必要的 Java 源代码文件，不推荐以 PRoject 为 JavaDoc 生成的源范围。

• 里面有一个 Locale 可选填项，表示的是需要生成的 JavaDoc 以何种语言版本展示，根据 javadoc.exe 的帮助说明，这其实对应的就是 javadoc.exe 的 -locale 参数，如果不填，默认可能是英文或者是当前操作系统的语言，既然是国人，建议在此填写 zh_CN，这样生成的 JavaDoc 就是中文版本的，当然指的是 JavaDoc 的框架中各种通用的固定显示区域都是中文的。你自己编写的注释转换的内容还是根据你注释的内容来。

• 还有一个“Other command line arguments:”可选填项，非常重要，是填写直接向 javadoc.exe 传递的参数内容。因为有一些重要的设置，只能通过直接参数形式向 javadoc.exe 传递。这里必须要填写如下参数：

  -encoding UTF-8 -charset UTF-8 -windowtitle "你的文档在浏览器窗口标题栏显示的内容" -link http://docs.Oracle.com/javase/7/docs/api

• 第一个参数 -encoding UTF-8 表示你的源代码（含有符合 JavaDoc 标准的注释）是基于 UTF-8 编码的，以免处理过程中出现中文等非英语字符乱码；第二个参数 -charset UTF-8 表示在处理并生成 JavaDoc 超文本时使用的字符集也是以 UTF-8 为编码，目前所有浏览器都支持 UTF-8，这样最具有通用性，支持中文非常好；第三个参数 -windowtitle 表示生成的 JavaDoc 超文本在浏览器中打开时，浏览器窗口标题栏显示的文字内容；第四个参数 -link 很重要，它表示你生成的 JavaDoc 中涉及到很多对其他外部 Java 类的引用，是使用全限定名称还是带有超链接的短名称，举个例子，我创建了一个方法 public void func(String arg)，这个方法在生成 JavaDoc 时如果不指定 -link 参数，则 JavaDoc 中对该方法的表述就会自动变为 public void func(java.lang.String arg)，因为 String 这个类对我自己实现的类来讲就是外部引用的类，虽然它是 Java 标准库的类。如果指定了 -link http://docs.oracle.com/javase/7/docs/api 参数，则 javadoc.exe 在生成 JavaDoc 时，会使用 String 这样的短名称而非全限定名称 java.lang.String，同时自动为 String 短名称生成一个超链接，指向官方 JavaSE 标准文档 http://docs.oracle.com/javase/7/docs/api 中对 String 类的详细文档地址。-link 实质上是告诉 javadoc.exe 根据提供的外部引用类的 JavaDoc 地址去找一个叫 package-list 的文本文件，在这个文本文件中包含了所有外部引用类的全限定名称，因此生成的新 JavaDoc 不必使用外部引用类的全限定名，只需要使用短名称，同时可以自动创建指向其外部引用 JavaDoc 中的详细文档超链接。每个 JavaDoc 都会在根目录下有一个 package-list 文件，包括我们自己生成的 JavaDoc。

　　JavaDoc 生成完毕，即可在其根目录下找到 index.html 文件，打开它就可以看到我们自己的标准 JavaDoc API 文档啦。

---

---

---

Java流程控制

1. 用户交互Scanner

   • 可以获取用户的输入 java.until.Scanner 通过Scanner来获取用户的输入

   • 基本语法： Scanner s = new Scanner(System.in)

   • 通过Scanner 类的next（）与nextLine（）方法获取输入的字符串，在读取我们一般需要 使用hasNext（）与hasnextLine（）判断是否还有输入的数据

   • next()

     • 1. 一定要读取到有效字符后才可以结束输入
       2. 对输入有效字符之前遇到的空白，next（）方法会自动将其去掉
       3. 只有输入有效字符后才将其后面输入的空白作为分隔符或者结束符
       4. next（）不能得到带有空格的字符串

       package com.kuang.scanner;
       
       import java.util.Scanner;
       
       public class Demo01 {
           public static void main(String[] args) {
               //创建一个扫描器对象，用于接受键盘数据
               Scanner scanner = new Scanner(System.in);
               System.out.println("使用next方式接收：");
       
               //判断用户有没有输入字符串
               if (scanner.hasNext()){
                   //使用next方式进行接收
                   String str = scanner.next(); //程序会等待用户输入完毕
                   System.out.println("输入的内容为：" + str); //输入hello world   输出为hello
               }
               //凡是属于IO流的类，如果不关闭会一直占用资源，要养成良好的习惯
               scanner.close();
           }
       }
       

   • nextLine（）

     • ​ 1.以Enter为结束符，也就是说next Line（）方法返回的是输入回车之前所有的字符串。
     • 可以获得空白

     package com.kuang.scanner;
     
     import java.util.Scanner;
     
     public class Demo02 {
         public static void main(String[] args) {
             //从键盘接收数据
             Scanner scanner = new Scanner(System.in);
     
             System.out.println("使用nextLine方式接收 ：");
             //判断是否还有输入
             if (scanner.hasNextLine()){
                 String str = scanner.nextLine();
                 System.out.println("输入的内容为 ： " + str);   //输入hello world  输出hello world
             }
             scanner.close();
         }
     }
     

package com.kuang.scanner;

import java.util.Scanner;

public class Demo03 {

public static void main(String[] args) { //去掉判断语句也可以正常执行

Scanner scanner = new Scanner(System.in); //只写等号右边 后按alt + enter会自动补全左边

System.out.println("请输入数据 ： ");

String str = scanner.nextLine();//只写等号右边 后按alt + enter会自动补全左边

System.out.println("输入的数据为 ： " + str);

}

}