IntelliJ IDEA查看內(nèi)聯(lián)文檔與外部文檔

IntelliJ IDEA 內(nèi)聯(lián)文檔

IntelliJ IDEA 快速文檔查找可幫助您獲取任何符號(hào)或僅方法簽名信息的快速信息，前提是此符號(hào)已提供了適用格式的文檔注釋。

IntelliJ IDEA 可識(shí)別根據(jù) Javadoc 標(biāo)記創(chuàng)建的內(nèi)聯(lián)文檔。

在這種情況下，此類文檔在 "快速文檔查找" 窗口中正確呈現(xiàn)：

對(duì)于標(biāo)記語(yǔ)言，IntelliJ IDEA 根據(jù)文檔類型設(shè)置從語(yǔ)言規(guī)范中檢索引用。

方法中的文檔注釋中指定的 URL 和電子郵件地址也可以正確呈現(xiàn)。單擊超鏈接將在外部瀏覽器中打開(kāi)相應(yīng)的 URL；單擊電子郵件地址將打開(kāi)默認(rèn)郵件客戶端。

IntelliJ IDEA 查看快速文檔

要在插入符號(hào)中查看符號(hào)的文檔，請(qǐng)執(zhí)行以下操作之一：

• 在主菜單上選擇查看| 快速文檔查找（View | Quick Documentation Lookup）。
• 按 Ctrl+Q。
• 如果選中了 "在編輯器設(shè)置中的鼠標(biāo)移動(dòng)時(shí)顯示快速文檔" 復(fù)選框，只需將鼠標(biāo)指針移動(dòng)到所需的符號(hào)上即可。

當(dāng)顯式調(diào)用代碼完成時(shí)，可以自動(dòng)顯示在"建議" 列表中所選條目的快速文檔?？焖傥臋n查找的行為在 "設(shè)置/首選項(xiàng)" 對(duì)話框的 "代碼完成" 頁(yè)中配置。

要更改快速文檔的字體大小，請(qǐng)執(zhí)行以下操作之一：

• 單擊"快速文檔" 窗口右上角的 ，并移動(dòng)滑塊。
• 按住 Ctrl 的同時(shí)旋轉(zhuǎn)鼠標(biāo)滾輪。

  請(qǐng)注意，要使此功能正常工作，您必須在編輯器設(shè)置的 "常規(guī)" 頁(yè)中啟用它。

  

  tip：連續(xù)按下 Ctrl + Q 可以切換快速文檔彈出窗口和文檔工具窗口的焦點(diǎn)。

IntelliJ IDEA 快速文檔查找工具欄

"快速文檔查找" 窗口可以通過(guò)超鏈接導(dǎo)航到相關(guān)符號(hào)，并提供了一個(gè)工具欄，用于在已導(dǎo)航的頁(yè)面中來(lái)回移動(dòng)、更改字號(hào)以及在外部瀏覽器中查看文檔。

有關(guān)在 JavaScript 或 PHP 上下文中檢索內(nèi)聯(lián)文檔的信息，請(qǐng)參閱查看 JSDoc 注釋和 PHPDoc 注釋的部分。

固定后，快速文檔查找將變成文檔工具窗口，并帶有相應(yīng)的側(cè)邊欄圖標(biāo)，以及更多的控件。

圖標(biāo)	鍵盤快捷鍵	描述
	Left 或者 Right	切換到上一個(gè)或下一個(gè)文檔頁(yè)面（例如：使用超鏈接之后）。 在 MacOS 計(jì)算機(jī)上，您也可以使用三指從右到左和從左到右的滑動(dòng)手勢(shì)。
	Shift+F1	在默認(rèn)瀏覽器中查看外部文檔。
	F4	切換到與當(dāng)前顯示的文檔頁(yè)面對(duì)應(yīng)的項(xiàng)目（例如源）。
		打開(kāi)或關(guān)閉 "源" 選項(xiàng)中的 "自動(dòng)更新"。當(dāng)該選項(xiàng)打開(kāi)時(shí)，工具窗口中的信息將與您在編輯器 UI 中其他位置的導(dǎo)航同步。
		單擊此圖標(biāo)可顯示字體大小滑塊。根據(jù)需要移動(dòng)滑塊以增加或縮小 "快速文檔" 窗口中的字體大小。

IntelliJ IDEA 查看外部文檔

IntelliJ IDEA 外部文檔使得您可以在插入符號(hào)處獲取符號(hào)的附加信息。與快速文檔相比，此功能在外部瀏覽器中顯示文檔，這有助于更詳細(xì)地研究符號(hào)，導(dǎo)航到相關(guān)符號(hào)，并保留信息以供進(jìn)一步參考。

外部文檔可以在正確配置時(shí)模塊結(jié)構(gòu)是查看。例如，在模塊路徑中，您可以添加一個(gè) JavaDoc 文件的路徑或指向文檔的鏈接；或?yàn)閹?kù)指定文檔 URL。

要在外部瀏覽器中以插入符號(hào)查看符號(hào)的文檔，請(qǐng)執(zhí)行以下操作之一：

• 在主菜單上選擇查看| 外部文檔。
• 按 Shift+F1。
• 在 "快速文檔查找" 窗口中，單擊 。