[文件] 閱讀 API 文件的入門指引

看板java作者TonyQ (沉默是金)時間16年前 (2008/11/29 15:48)推噓13(13推 0噓 2→)

留言15則, 12人參與討論串1/1

這是跟系上學弟在討論java後 , 有感於api的重要以及對於新手時期的窒礙，所以順手寫的文件 , 分享給各位新入門的同好. 對任何 java JDK default 的Class 如果有疑惑 , 一定要先好好翻過api document. API 網址 (for jdk 1.5 , 不過1.5後版本差異對新手應該還好.) http://java.sun.com/j2se/1.5.0/docs/api/ ──────────────────────────────── 左下角是全部Class的名字點選後會出現介紹在右邊右邊最重要的是 Method Summary 那區前面的int/String 是回傳的型態(return type) , 藍字的是包含傳入參數 (parameter) 的函式名稱(method name). 註：要閱讀 api document , 最起碼最起碼應該對 method 有最基本的認識, 瞭解什麼是傳入參數 (parameter) 跟回傳型態 (return type). ──────────────────────────────── 一張簡單的結構簡圖 , 預設右方是顯示packagelist , 不過此處講的是點選左下特定類別名稱(class name)之後的查詢畫面. ┌─────┬────────────────────┐ │package │ class name │ │ │ implements interface │ ├─────┤ 類別的說明... │ │ │ │ │ClassName │ Field Summary │ │ │ 靜態成員變數表 │ │ List │ Constructor Summary │ │ │ 建構子一覽表 │ │ │ Method Summary │ │ │ 類別函數一覽表 │ │ │ Methods inherited from │ │ │ 繼承來的函數一覽表 │ │ │ │ │ │ Field Detail │ │ │ 靜態成員詳細資料 │ │ │ Constructor Detail │ │ │ 建構子詳細資料 │ │ │ Method Detail │ │ │ 函式詳細資料 │ └─────┴────────────────────┘ *深灰色字是新手還可以不用太花腦力去了解的區域. ──────────────────────────────── 一開始會不太習慣，但只要你知道如何查類別函式(method) 用途後，它會變得很親切。底下是一個step by step的查詢體驗以查詢 String.indexOf() 為例 ──────────────────────────────── 1.左下角找到名字確實符合String的資料後點選 (hint. 可以先點左下角的區域 , 再用ctrl+f打類別名稱搜尋 ,ex.String. ) 2.右邊往下翻到有indexOf字眼的位置你應該會在 method Summary 區找到幾個符合的,底下列出其中兩個做說明。 int 回傳型態 indexOf(int ch) 函數名稱 Returns the index within this string of the first occurrence of 函數摘要 the specified character. 註：回傳這個char在指定字串出現的第一個位置索引值常用的會是這個 indexOf(String str) 我覺得需要介紹的是這個 indexOf(String str, int fromIndex) int indexOf(String str, int fromIndex) Returns the index within this string of the first occurrence of the specified substring, starting at the specified index. 註：return 這索引值在這字串中的特定位置 , 從指定的索引指開始. ──────────────────────────────── 最少最少，它可以很快的告訴你它這個函式的 input / output，還有它設計的目的與用意，當然它還有提供更多能詳細參考的資料，但這部份可能要讀者研究 javadoc 的格式與那些資料的意義才比較好說明。 api 算是扮演著你設計時或者是在別人丟了keyword或函數名之後 , 你可以去查詢的方向 ,新手想要精進自己功力 , 一開始請千萬務必要跟api document好好相處. -- 文末補註：對英文有困擾者，請善用雅虎字典 http://tw.dictionary.yahoo.com/ ，並發揮中文訓練中的有邊讀邊沒邊讀中間的試誤精神來閱讀，通常都不會差的太離譜. -- What do you want to have ? / What do you have? 從書本中，你可以發現我的各種興趣。從ＣＤ中，你可以瞭解我所喜歡的偶像明星。或許從文字你很難以瞭解一個人，但從物品可以。 My PPolis , My past. http://ppolis.tw/user/Tony -- ※ 發信站: 批踢踢實業坊(ptt.cc) ◆ From: 221.169.78.140

推

H45

11/29 16:29, , 1^F

11/29 16:29, 1^F

推

jtmh

11/29 17:18, , 2^F

11/29 17:18, 2^F

推

SmileJoS

11/29 17:38, , 3^F

11/29 17:38, 3^F

→

TonyQ

11/29 17:59, , 4^F

11/29 17:59, 4^F

修飾幾行寫得太隨性的句子...:p ※ 編輯: TonyQ 來自: 221.169.78.140 (11/29 18:05) ※ 編輯: TonyQ 來自: 221.169.78.140 (11/29 18:07)