IntelliJ IDEA文檔注釋

IntelliJ IDEA 文檔注釋

IntelliJ IDEA 為創(chuàng)建文檔注釋提供了方便的功能。

您的源代碼中的文檔注釋可用于快速文檔查找并通過按 Ctrl + Q 打開以進行審閱。

在 Java 文件中，IntelliJ IDEA 在鍵入打開標(biāo)簽并按下 Enter 鍵時創(chuàng)建文檔注釋的存根。

如果此功能適用于方法，則會為方法簽名中聲明的每個參數(shù)創(chuàng)建 @param 標(biāo)簽；@return 如果方法不是無效的，則創(chuàng)建 @return 標(biāo)簽；并為每個異常語句創(chuàng)建 @throws 標(biāo)簽。

當(dāng)您創(chuàng)建其他標(biāo)簽時，IntelliJ IDEA 提供代碼完成，提示可能的標(biāo)簽名稱。

如果某個標(biāo)簽具有多個值，則相同的代碼完成提供可用值的列表。智能類型代碼完成表明適用于特定異常的類的列表。

IntelliJ IDEA 使用 Python 創(chuàng)建文檔注釋

注意：僅當(dāng)安裝 Python 插件時才支持以下功能！

可以根據(jù)在"設(shè)置/首選項" 對話框的 "Python 集成工具" 頁面中選擇的語法創(chuàng)建文檔注釋，例如：reStructuredText 或 epytext。如果此功能適用于某個函數(shù)，則IntelliJ IDEA 將根據(jù)所選的文檔字符串格式生成標(biāo)簽，例如：

• 對于 reStructuredText：在函數(shù)簽名中聲明的每個參數(shù)的 :param 標(biāo)簽和 :return標(biāo)簽。
• 對于 epytext：為在函數(shù)簽名中聲明的每個參數(shù)的 @param 標(biāo)簽和 @return 標(biāo)簽。

這樣做，會讓 reStructuredText 和 epytext 標(biāo)記中的標(biāo)簽被相應(yīng)地突出顯示。

如果配置，則可以使用 type 和 rtype 標(biāo)簽生成文檔注釋存根。

在 Python 文件中，IntelliJ IDEA 識別了表示以 Python 文檔字符串表示的文檔注釋。

在開始之前，請確保在 "設(shè)置/首選項" 對話框的 "Python 集成工具" 頁中選擇了所需的文檔字符串格式 (例如：epytext 或 reStructuredText)。

另外還要注意，IntelliJ IDEA 從 conf. 中捕獲自定義角色。當(dāng)配置包含 *.rst 文件的目錄時，指向帶有 conf. 的目錄（Python 集成工具| 帶有 *. rst 文件的目錄的路徑）。

注意：只有在安裝 Ruby 插件時才支持以下功能！

IntelliJ IDEA 使用 RDoc 創(chuàng)建文檔注釋

RDoc 標(biāo)簽已完成：

可以啟用或禁用文檔注釋中的 RDoc 突出顯示。要啟用它，請在編輯器設(shè)置的 "外觀" 頁中選中 "注釋中的 RDoc 和 ruby 語法"復(fù)選框。

IntelliJ IDEA 使用 YARD 創(chuàng)建文檔注釋

YARD 標(biāo)簽已完成：

• YARD 指令在可以定義方法的地方完成；
• 類型注釋在適用的情況下完成（分配，在塊變量之前）；
• param/return/etc. 標(biāo)簽在方法之前完成，內(nèi)部指令文檔字符串，在 attr_reader/writer/accessor 之前。
  

IntelliJ IDEA 使用 HEREDOC 創(chuàng)建文檔注釋

除了 RDOC 和 YARD 格式的文檔注釋外，IntelliJ IDEA 還支持 HEREDOCS 格式的文檔注釋。如果您正在編寫大塊的文本，這將特別有用。

例如，請考慮以下幾點：

Note：IntelliJ IDEA 建議 Ruby 意圖行為，將<< - HEREDOC 轉(zhuǎn)換成波形 <<?HEREDOC。這個意圖適用于 Ruby 2.3 及更高版本。

如果您執(zhí)行運行，<< - HEREDOC 和 HEREDOC 之間的行將出現(xiàn)在 "運行工具" 窗口中。