讀古今文學網 > iOS編程基礎:Swift、Xcode和Cocoa入門指南 > 8.1 文檔窗口 >

8.1 文檔窗口

在Xcode中,訪問文檔的主要途徑是通過文檔窗口(Window→Documentation and API Reference或Help→Documentation and API Reference,Command-Shift-0)。在文檔窗口中,查看文檔的主要方式是通過搜索進行的;比如,按下Command-Shift-0(如果已經在文檔窗口中,那就請按下Command-L),輸入NSString並回車,選擇第一個結果,即NSString類參考。如果需要,可以單擊放大鏡圖標將結果限定在iOS相關的文檔集中。

在文檔窗口中有兩種方式可以查看搜索結果:

彈出結果窗口

如果不斷在搜索框中輸入,那麼會有很多結果列在彈出窗口中。使用鼠標單擊,或通過箭頭鍵導航,然後按下回車鍵,指定想要查看的結果。如果搜索框獲得了焦點,那麼還可以通過按下Esc鍵彈出或隱藏這個彈出窗口。

完整的結果頁面

如果搜索框獲得了焦點,但彈出結果窗口沒有出現,那麼可以按下回車鍵查看列出了所有搜索結果的頁面;這些結果會根據類別列在4個單獨的頁面中,類別分別是API參考、SDK指南、工具指南與示例代碼。

還可以從代碼中進行文檔窗口搜索。你會經常這麼做:你想在代碼中直接查看用到的某個符號(類名、方法名或屬性名等),並且想瞭解關於它的更多信息。按住Option鍵並將鼠標懸浮在代碼中的某個符號上,直到出現一個藍色的點狀下劃線;接下來(依然要按下Option鍵),雙擊該符號。這會打開文檔窗口,你會直接進入類文檔頁面中對該術語的解釋部分,或完整的搜索結果頁面中。

(與之類似,第9章將會介紹的代碼完成過程中,可以單擊More鏈接完成相同的事情,直接跳轉到當前符號對應的文檔中。)

此外,可以在代碼中(或其他地方)選定一段文本,然後選擇Help→Search Documentation for Selected Text(Command-Option-Control-/)。這相當於在文檔窗口的搜索框中輸入該文本,然後查看完整的結果頁面。

文檔窗口像是一個漂亮的Web瀏覽器,因為文檔本質上包含的是網頁。多個頁面可以同時出現在文檔窗口的頁簽中。要想導航到新的頁簽,請在導航時按住Command鍵(比如,按住Command鍵並單擊某個鏈接,或按住Command鍵並單擊彈出結果窗口中所選的某項),或從上下文菜單中選擇Open Link in New Tab。可以在頁簽之間導航(Window→Show Next Tab),每個頁簽都會記住其導航歷史(Navigate→Go Back,或是使用窗口工具欄中的後退按鈕,它也是個彈出菜單)。

可以在Web瀏覽器中打開當前在文檔窗口中所查看的頁面,方式是選擇Editor→Share→Open in Browser。

文檔頁面可能還會帶有一個相關條目列表。列表開頭會顯示在頁面上方的窗格中;當單擊「More related items」鏈接時,完整列表會彈出來(如圖8-1所示)。比如,NSString類參考頁面的相關條目窗格包含了NSString類繼承與使用的協議的鏈接,同時在彈出層中還會顯示出更多的信息與鏈接。本章後面將會介紹關於類相關條目的更多信息。

圖8-1:UIButton類文檔頁的開頭

文檔頁面可能會帶有一個目錄,顯示在文檔頁面左側的窗格中(如圖8-1所示);如果沒有顯示,那麼請選擇Editor→Show Table of Contents,或單擊窗口工具欄中的Table of Contents圖標。比如,NSString類參考頁面就有一個目錄窗格,它鏈接到該頁面中的所有主題與方法。一些文檔頁面會通過目錄來展示頁面在更大規模的頁面組中的位置;比如,String編程指南就包含了多個頁面,在查看一個頁面時,目錄窗格會列出所有的String編程指南頁面以及每個頁面的主題內容。

針對所有文檔集(庫)的完整的層次目錄位於文檔窗口的最左側;如果沒有顯示,請選擇Editor→Show Library,或單擊窗口工具欄中的導航按鈕。該層次目錄展示了所有的參考文檔,同時還有指南與示例代碼,並根據主題進行分類。在查看文檔頁面時,要想在完整的層次目錄中看到它,請選擇Editor→Reveal in Library(或從上下文菜單中選擇Reveal in Library)。

如果希望後面再訪問某個文檔頁,那麼可以將其標記為書籤,方式是選擇Editor→Share→Add Bookmark,單擊工具欄中的Share按鈕並選擇Add Bookmark,或單擊文檔頁左側的書籤圖標(這也是最簡單的方式)。書籤會顯示在文檔窗口的左側,在導航器中與完整的層次目錄在一起;如果書籤窗格沒有顯示出來,那麼請選擇Editor→Show Bookmarks。可以通過導航器頂部的圖標在庫窗格與書籤窗格之間切換。單擊書籤窗格中的書籤會跳轉到文檔窗口。書籤的管理是非常簡單的,同時又很有用:可以重新排列或刪除書籤。

要在當前的文檔頁中搜索文本,請使用Find菜單命令。Find→Find(Command-F)會彈出一個搜索框,就像在Safari中一樣。

第三方文檔查看器應用,如Dash(http://kapeli.com/dash),提供了比文檔窗口更優秀的本地文檔集搜索與查看功能。此外,大多數文檔都可以通過Web瀏覽器查看,地址是http://developer.apple.com,即Apple公司的開發者站點;通過Web瀏覽器可以顯示或隱藏頁面的各個部分,它包含了對方法與屬性的按照字母搜索的索引,甚至還會顯示出文檔窗口遺漏的信息。