IntelliJ IDEA外部注釋的使用

IntelliJ IDEA 外部注釋

在您使用 IntelliJ IDEA 注釋源代碼的時(shí)候，您需要考慮這樣的一個(gè)情況：如果需要用 @Nullable/@NotNull 或 @NonNls 注釋符號(hào)，但是要避免在源代碼中注釋。這可能是一個(gè)團(tuán)隊(duì)在一個(gè)項(xiàng)目上工作時(shí)使用了不同的 IDE（例如 IntelliJ IDEA 和 Eclipse），或在使用庫類時(shí)會(huì)出現(xiàn)。

這種情況下 IntelliJ IDEA 建議使用存儲(chǔ)在源代碼之外的外部注釋。有關(guān)注釋符號(hào)的信息存儲(chǔ)在 XML 文件中，而不是源代碼中。每個(gè)條目將一個(gè)方法參數(shù)或返回值映射到所需的注釋類。

此類文件具有名稱：annotations.xml，并位于依賴于特定注釋的來源的路徑中。如果某個(gè)注釋屬于與您的項(xiàng)目配置的 SDK，則該路徑將在 SDK 設(shè)置中進(jìn)行定義。如果注釋屬于模塊，則應(yīng)在模塊設(shè)置中定義路徑。

本節(jié)將簡(jiǎn)要說明 IntelliJ IDEA 的外部注釋。要了解如何啟用、配置和創(chuàng)建外部注釋，請(qǐng)參閱使用外部注釋的部分。

IntelliJ IDEA 使用外部注釋

如果您想要 IntelliJ IDEA 使用外部注釋，您必須啟用此功能，并指定將存儲(chǔ)外部注釋的目錄。

如何啟用 IntelliJ IDEA 外部注釋

1. 在 "Java 代碼樣式" 頁的 "代碼生成" 部分中，選中 "使用外部批注" 復(fù)選框。
   
   
2. 應(yīng)用更改并關(guān)閉對(duì)話框。

在 SDK 級(jí)別定義外部注釋的路徑

1. 打開 “項(xiàng)目結(jié)構(gòu)”對(duì)話框（例如按：Ctrl+Shift+Alt+S）。
2. 在"平臺(tái)設(shè)置" 部分中，單擊 "SDK"。
3. 在 SDK 頁面中，選擇“注釋”選項(xiàng)卡。
4. 單擊“添加”按鈕，并在“選擇路徑”對(duì)話框中指定所需的路徑。您可以根據(jù)需要?jiǎng)?chuàng)建任意數(shù)量的注釋路徑。
5. 應(yīng)用更改并關(guān)閉對(duì)話框。

IntelliJ IDEA 定義模塊的外部注釋的路徑

1. 在項(xiàng)目的上下文菜單中，選擇“模塊設(shè)置”?！绊?xiàng)目結(jié)構(gòu)”對(duì)話框顯示在“模塊”頁面上。
2. 選擇“路徑”選項(xiàng)卡。
3. 在“外部注釋”部分，單擊 "添加"，并在 "選擇路徑" 對(duì)話框中指定所需的路徑。您可以根據(jù)需要?jiǎng)?chuàng)建任意數(shù)量的注釋路徑。
4. 應(yīng)用更改并關(guān)閉對(duì)話框。

使用 IntelliJ IDEA 外部注釋來注釋符號(hào)

按照以下一般步驟操作：

1. 如果代碼檢查提醒您需要對(duì)符號(hào)進(jìn)行注釋，請(qǐng)按 Alt+Enter 以顯示意圖操作列表，然后選擇適當(dāng)?shù)淖⑨屆睿纾?br>
   

2. 在打開的對(duì)話框中，單擊“添加外部”按鈕。
   

   

   note：如果啟用了外部注釋，則會(huì)顯示此對(duì)話框。否則，默認(rèn)情況下會(huì)將注釋添加到源代碼中。