IntelliJ IDEA如何創(chuàng)建文檔注釋

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

請注意：本節(jié)引用了 JavaScript、Java、Python 和其他具有特殊文檔注釋開頭的語言。本節(jié)不引用 Ruby。

IntelliJ IDEA 可以使用專用的操作創(chuàng)建文檔注釋和修復(fù)文檔注釋，可以通過 "查找操作" 命令調(diào)用它。

按 Ctrl+Shift+A，將插入符號放在類、方法、函數(shù)或字段中的某個位置，字符應(yīng)被記錄，并輸入操作名稱修復(fù)文檔字符串。添加了相應(yīng)標(biāo)簽的缺少文檔存根。例如：

/**
*
* @param userInput
* @return
*/
static boolean processRepeatConversion (@NotNull String userInput) {
boolean repeatConversion = false;
if (((userInput.equals("y")) || (userInput.equals("Y")))) {
repeatConversion = true;
}
return repeatConversion;

}

IntelliJ IDEA 修復(fù)文檔注釋

接下來的示例說明了現(xiàn)有文檔注釋中的修復(fù)問題。

下一個案例在現(xiàn)有文件評論中出現(xiàn)了修復(fù)問題。

例如，如果方法簽名已更改，IntelliJ IDEA 將突出顯示與方法簽名不匹配的標(biāo)記，并建議快速修復(fù)。

tip：修復(fù)文檔注釋的操作沒有鍵盤快捷鍵，但是您可以配置你自己的鍵盤快捷方式。

對于 JavaScript，IntelliJ IDEA 建議一個意圖行為 UpdateJSDoc 評論。您也可以按 Ctrl+Shift+A，然后鍵入操作名稱：

IntelliJ IDEA 為方法和函數(shù)創(chuàng)建文檔注釋

在 IntelliJ IDEA 中可以為方法或函數(shù)創(chuàng)建文檔注釋，具體的操作步驟如下所述：

1. 在聲明前放置插入符號。
2. 鍵入開啟塊注釋/**，然后按 Enter 鍵。
3. 添加有意義的參數(shù)描述和返回值。

在您使用 IntelliJ IDEA 為方法和函數(shù)創(chuàng)建文檔注釋的時候，請您注意以下事項：

• IntelliJ IDEA 會檢查文檔注釋中的語法，并根據(jù)錯誤設(shè)置對其進行處理。
• 如果輸入的文本包含 HTML 標(biāo)簽，則在鍵入 > 后將自動添加結(jié)束標(biāo)簽，前提是在編輯器設(shè)置中啟用了此行為。
• 當(dāng)在輸入文檔注釋時，插入符號會自動移動到預(yù)期的位置。例如：
  
  

IntelliJ IDEA 在文檔注釋塊中創(chuàng)建標(biāo)簽

1. 在注釋塊中，選擇所需的空行和輸入@或 character （對于 Python 和 Ruby 語言）。
2. 按 Ctrl+Space，或者只是等待代碼完成顯示建議列表：
   
   
3. 從建議列表中選擇一個標(biāo)簽。例如，您可以指定參數(shù)類型或返回類型。
4. 如果某個標(biāo)簽有多個值，請在標(biāo)簽后按 Ctrl+Space ，然后從建議列表中選擇所需的值。例如，IntelliJ IDEA 建議選擇所需的參數(shù)名稱。
   
   

注意：以下僅在安裝并啟用 Ruby Plugin 時有效！

IntelliJ IDEA 為 Ruby 方法創(chuàng)建文檔注釋

1. 將插入符號放在要記錄的方法聲明之前的空行上
2. 鍵入文檔注釋的開頭（＃），或者只是按 Ctrl+Slash。
3. 按 Ctrl+Space，并從建議列表中選擇所需的標(biāo)簽。然后再次按 Ctrl+Space，然后選擇所需的參數(shù)名稱：
   
   

要使用意圖行為為 Ruby 方法創(chuàng)建文檔注釋，請執(zhí)行以下操作之一：

• 將插入符放在要記錄的方法中的任何位置，按下 Alt+Enter 并選擇 "添加 @return 標(biāo)記"。將創(chuàng)建帶有 @return 標(biāo)記的文檔注釋。指定返回類型：
  
  
• 將插入符號放在要記錄的參數(shù)上，按 Alt+Enter，然后選擇 "添加 @param 標(biāo)簽"。將創(chuàng)建帶有所選參數(shù)的 @param 標(biāo)簽的文檔注釋。指定參數(shù)類型：
  
  

以下僅在安裝并啟用 Python Plugin 時有效！

IntelliJ IDEA 為 Python 函數(shù)創(chuàng)建文檔注釋

您需要注意以下幾點：

• 當(dāng)在編輯器設(shè)置頁面的智能鍵頁面中清除了“插入引號對”復(fù)選框時，如果按下 Space 鍵生成的文檔字符串會有打開三重引號。

• 如果重命名一個函數(shù)的參數(shù)，IntelliJ IDEA 將相應(yīng)地更新文檔注釋中的標(biāo)記。

為 Python 函數(shù)創(chuàng)建文檔注釋的操作步驟如下：

1. 將插入符號放在要記錄的函數(shù)聲明之后。
2. 鍵入 "打開三重號"，然后按 Enter，或 Space。
3. 添加有意義的參數(shù)描述和返回值。

使用意圖行為為 Python 函數(shù)創(chuàng)建文檔注釋的步驟：

1. 將插入符號放在要記錄的函數(shù)中的某個位置。
2. 按 Alt+Enter 顯示可用的意圖行為。
3. 選擇插入文檔字符串存根：
   
   

   IntelliJ IDEA 根據(jù) 文檔字符串格式生成文檔注釋存根，在 Python 集成工具頁面中選擇。

使用 Python 注釋的例子：

考慮以下功能：

def handle(self, myParam1, myParam2):

在 "Python 集成工具" 頁中，選擇 "Epytext"。然后鍵入打開的三重引號，然后按 Enter 或 Space。IntelliJ IDEA 生成文檔注釋存根：

'''
@param self:
@param myParam1:
@param myParam2:
@return:
'''

然后選擇 reStructuredText，鍵入打開的三重引號，然后按 Enter 或 Space。IntelliJ IDEA 生成文檔注釋存根：

'''
:param self:
:param myParam1:
:param myParam2:
:return:
'''

IntelliJ IDEA 填充段落

Java 注釋 支持“填充段落”操作。此操作會在注釋中創(chuàng)建軟包裝。要使用此操作，請按照下列步驟操作：

1. 將插入符號放在類中的某個注釋內(nèi)。
2. 執(zhí)行以下操作之一：
   • 在主菜單上選擇編輯|填充段落。
   • 按下 Ctrl+Shift+A，在彈出框中，鍵入填充段落，然后按 Enter 鍵。

IntelliJ IDEA 中可點擊的注釋

如果文檔注釋包含超鏈接，您可以使其可點擊。

要做到這一點，請執(zhí)行以下操作之一：

• 按住 Ctrl 鍵并將鼠標(biāo)指針懸停在超鏈接上：
  
  
• 按 Ctrl+B。