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);

}

}