點(diǎn)擊此處，立即下載通義靈碼！https://tongyi.aliyun.com/lingma/

通義靈碼最佳使用實(shí)踐參考

通義靈碼是JetBrains或VSCode集成開發(fā)環(huán)境（IDE）中嵌入的一款智能開發(fā)助手工具，旨在通過人工智能技術(shù)簡化軟件開發(fā)過程，提升開發(fā)效率。本文將介紹在開發(fā)過程中如何深度體驗(yàn)多種輔助功能。其主要功能包括：通用大模型問答、生成單元測試、提供場景優(yōu)化、編寫說明文檔，以及根據(jù)您的代碼生成高質(zhì)量AI驅(qū)動的代碼等。這些功能為開發(fā)者提供了顯著的便利與效率提升。

快捷鍵的運(yùn)用

默認(rèn)快捷鍵

通義靈碼的多個操作均配備了開箱即用的快捷鍵，以下列出了幾項(xiàng)常用的快捷鍵。

此外，在通義靈碼的問答面板中，用戶可以通過使用 Cmd+Enter（適用于 MacOS/Linux）或 Ctrl+Enter（適用于 Windows）來實(shí)現(xiàn)換行功能。請注意，直接按下 Enter 回車鍵將立即將當(dāng)前提問內(nèi)容發(fā)送給模型。

說明：使用更換生成結(jié)果快捷鍵會提高生成的多樣性參數(shù)（temperature），有時能生成更長或更發(fā)散的內(nèi)容。

自定義快捷鍵

JetBrains IDE

1. 首先打開菜單欄中的設(shè)置頁面。
2. 在面板左側(cè)選擇“快捷鍵”（Keymap），隨后找到“插件”（Plugins）中的“TONGYI Lingma”子項(xiàng)，展開后即可查看和編輯相關(guān)快捷鍵。

VSCode

1. 請單擊 IDE 左下角的設(shè)置圖標(biāo)，隨后選擇鍵盤快捷方式菜單。

2. 在頁面中搜索“TONGYI Lingma”，即可查看和編輯所有快捷鍵。

說明：為了便于識別，VSCode 的大部分通義靈碼快捷鍵都是以 TONGYI Lingma 命名的，但觸發(fā)內(nèi)聯(lián)建議、顯示上一個/下一個內(nèi)聯(lián)建議快捷鍵復(fù)用了已經(jīng)存在系統(tǒng)級功能項(xiàng)，因此命名風(fēng)格上稍有差異。

配置的運(yùn)用

配置面板

JetBrains IDE

JetBrains IDE 的配置面板位于設(shè)置頁面的頂級菜單“TONGYI Lingma”板塊。可以通過單擊狀態(tài)欄中的通義靈碼小圖標(biāo)，迅速選擇“高級設(shè)置”項(xiàng)進(jìn)行訪問。

VSCode

VSCode 的配置面板同樣可以從狀態(tài)欄右下角的通義靈碼圖標(biāo)點(diǎn)擊“高級設(shè)置”進(jìn)入。

常用配置項(xiàng)

1. 按文件類型禁用自動補(bǔ)全功能。

• 如果某些類型的文件在使用自動補(bǔ)全時產(chǎn)生干擾，可將該文件的后綴類型添加至列表中。多種后綴之間應(yīng)使用英文逗號分隔（例如：txt,md）。

說明：禁用特定文件類型的自動補(bǔ)全功能主要是指禁用自動補(bǔ)全觸發(fā)。然而，在文件內(nèi)通過快捷鍵手動觸發(fā)補(bǔ)全（默認(rèn)快捷鍵為 Alt+P）時，仍然可以使用大模型的內(nèi)容自動續(xù)寫生成的功能。

2. 下拉提示時保留補(bǔ)全結(jié)果。

• 默認(rèn)情況下，當(dāng) IDE 有基于語法的下拉補(bǔ)全提示時，通義靈碼會自動停止展示大模型補(bǔ)全內(nèi)容，避免視覺上的沖突。image

• 若希望通義靈碼總是生成大模型補(bǔ)全，可以勾選該配置項(xiàng)，效果如下圖所示，此時按下 Tab 鍵將會采納大模型的生成結(jié)果。image

3. 生成長度控制。

• 通義靈碼支持將自動觸發(fā)和手工觸發(fā)的代碼續(xù)寫能力分別設(shè)置生成長度參數(shù)。通常建議將手工觸發(fā)（默認(rèn)快捷鍵 Alt+P） 設(shè)置得比自動觸發(fā)稍長。

說明：這個配置項(xiàng)只是設(shè)置模型允許生成的最大長度，若模型某次補(bǔ)全生成的內(nèi)容長度原本就較短，通過修改此配置并不能讓模型生成的內(nèi)容變長。

代碼注釋的運(yùn)用

通過注釋引導(dǎo)補(bǔ)全生成

在缺乏額外注釋引導(dǎo)的情況下，模型只能基于當(dāng)前代碼的上下文，以及項(xiàng)目中引用和找到的相似代碼來推測接下來可能要編寫的內(nèi)容。當(dāng)模型的推測不準(zhǔn)確時，可以通過增加代碼的方式來引導(dǎo)模型實(shí)現(xiàn)所需的代碼。

1. 例如，在以下這段代碼中，模型首先推測了一個 CHAT_CONTEXT 字段，然而并不是我們所期望的內(nèi)容。

2. 接下來，我們添加一行注釋，以指示模型下一個字段為歷史記錄。隨后，模型生成了符合預(yù)期的字段及其相應(yīng)的數(shù)據(jù)填充代碼。

使用描述生成方法

1. 通過“編輯區(qū)的代碼注釋引導(dǎo)補(bǔ)全”或“使用通義靈碼問答面板”，均可實(shí)現(xiàn)基于注釋生成整個方法的目標(biāo)。由于通義靈碼的智能問答場景所使用的模型參數(shù)量通常大于代碼補(bǔ)全模型的參數(shù)量，因此，對于這類場景，通常建議在問答面板中直接提出所需生成的問題描述。

2. 如果對期望生成的語言或方法簽名（包括方法名、參數(shù)類型、返回值類型）有特殊要求，請?jiān)谔釂枙r詳細(xì)描述該方法簽名。

跨文件索引的運(yùn)用

及時保存文件并更新索引

1. 通義靈碼的跨文件索引是抑制代碼幻覺的重要機(jī)制。通過自動識別當(dāng)前上下文中所涉及的類型和方法定義，模型能夠感知項(xiàng)目中其他文件的類型所包含的成員以及方法所具有的參數(shù)。在首次打開新項(xiàng)目時，通義靈碼將自動創(chuàng)建項(xiàng)目的文件索引。此后，每次保存文件時，將觸發(fā)單個文件的增量索引更新。然而，由于集成開發(fā)環(huán)境（IDE）中的文件通常存在內(nèi)存緩存，在剛剛編寫完一個文件后切換到另一個文件時，可能因本地索引尚未更新而無法識別新增加或修改過的內(nèi)容，仍然按照原有的類型結(jié)構(gòu)進(jìn)行推理。例如在某代碼項(xiàng)目中，我們?yōu)?Pet 對象新增了一個 saleable 屬性。

2. 隨后切換至另一個文件，嘗試讓大模型進(jìn)行補(bǔ)全，但模型推理出的邏輯使用的是另一個不太相關(guān)的字段。

3. 若要消除這種信息差異，建議在編輯完前一個文件后，主動按下文件保存鍵快捷鍵Ctrl+S，然后再繼續(xù)編輯其他文件。這樣生成的內(nèi)容將能夠正確引用到修改過的對象結(jié)構(gòu)。

針對MyBatis場景的優(yōu)化方案

除了 Java、Python、JavaScript 等主流編程語言項(xiàng)目的跨文件引用功能，通義靈碼還支持在編寫 MyBatis 的 XML 文件時自動識別 Mapper 對象所引用的表結(jié)構(gòu)類型。例如，在編寫如下的 insert 語句時，插件會利用當(dāng)前項(xiàng)目中的 TexiOrder 類型信息，確保生成的每個字段都為正確的。

及時清理上下文信息

適時清空上下文

在同一次會話中，前文的對話內(nèi)容會在每次向大模型提問時，自動作為上下文提供給模型。當(dāng)實(shí)際提問的是一個與前文無關(guān)的問題時，這些額外信息可能會對模型的回答產(chǎn)生干擾。

此時，用戶可以單擊問答面板頂部的新建會話按鈕，以在新的會話中進(jìn)行提問，或使用/clear context命令清空上下文，以減少前文對后續(xù)問答的干擾。

查看歷史對話記錄

在創(chuàng)建新的會話后，如需查找之前提問的內(nèi)容，可利用歷史記錄功能返回至先前的話題，并繼續(xù)進(jìn)行追問。

基于代碼提問

通用問答

若需要基于特定代碼段的內(nèi)容進(jìn)行提問，除了可以直接將代碼內(nèi)容粘貼到問答區(qū)外，還可以先在代碼編輯器中選擇一段代碼，然后在問答區(qū)針對該段代碼進(jìn)行提問，例如。

內(nèi)置代碼任務(wù)

1. 通義靈碼插件內(nèi)置了四項(xiàng)代碼任務(wù)：解釋代碼、生成單元測試、生成代碼注釋和生成優(yōu)化建議。通義靈碼大語言模型針對這些任務(wù)進(jìn)行了專項(xiàng)訓(xùn)練。例如，在生成單元測試的情況下，使用內(nèi)置任務(wù)的效果優(yōu)于先框選代碼后再輸入生成單元測試的方式。

2. 代碼任務(wù)有三種使用方式。其中最常用的方式是在方法定義的開頭，點(diǎn)擊通義靈碼的小圖標(biāo)，并在下拉選項(xiàng)中直接選擇所需執(zhí)行的任務(wù)。

a. 第一種方式，是使用IDE下拉菜單的方法。

b. 第二種方式，選擇代碼后右鍵單擊鼠標(biāo)，并從上下文菜單中選擇“通義靈碼”選項(xiàng)。整屏示例@1x

c. 第三種方式，選擇代碼后在問答面板輸入斜線（/）以激活內(nèi)置任務(wù)菜單，接著選擇相應(yīng)的任務(wù)。整屏示例@1x

提示詞的使用技巧

在提問中引用所選代碼

在提問時，如果同時在代碼編輯區(qū)選擇了文本或代碼段，所選擇的內(nèi)容將自動以 Markdown 引用格式附加到提問內(nèi)容的末尾。因此，若在提示詞中提及所選擇的代碼，應(yīng)使用“如下代碼”或“以下內(nèi)容”，例如。

• 正確的說法：請檢查以下代碼是否存在下標(biāo)越界風(fēng)險。
• 錯誤的說法：請檢查選中的代碼是否存在下標(biāo)越界風(fēng)險。 （模型并不知道選中的代碼是什么）

在使用命令時，請附加相關(guān)信息。

通過在命令后追加更多的輔助信息，可以為問答提供更為豐富的上下文，從而獲得更符合預(yù)期的回復(fù)。

通過多輪對話生成有效代碼

在與大語言模型進(jìn)行對話時，提供的上下文越豐富，生成的結(jié)果越能符合用戶的預(yù)期。因此，用戶可以在上一輪對話的基礎(chǔ)上繼續(xù)進(jìn)行問答，從而增加后續(xù)提問的上下文信息，這樣生成的結(jié)果能夠更好地反映整個歷史上下文。然而，上一輪的歷史信息有時可能會造成干擾，此時用戶需要適時清空上下文。

在上一輪的基礎(chǔ)上，進(jìn)一步進(jìn)行深入追問。

為模型提供參考示例

當(dāng)需要模型按照指定格式輸出或遵循特定前置規(guī)則時，提供一個參考實(shí)例往往能取得更好的效果，而非僅用文字描述。例如，某一程序的運(yùn)行結(jié)果文件可以使通義靈碼整理成特定的 JSON 結(jié)構(gòu)文檔。首先，打開文件并全選問題內(nèi)容，然后在問答區(qū)域進(jìn)行提問。對比下述兩種提示詞，后者能夠更穩(wěn)定地輸出預(yù)期的數(shù)據(jù)格式。

• 提示詞1：將測試報(bào)告整理為JSON格式，每個測試結(jié)果為一個JSON結(jié)構(gòu)。用例名稱應(yīng)放置于name字段，成功與否應(yīng)記錄于success字段，運(yùn)行耗時需在duration字段中體現(xiàn)（單位為毫秒），測試覆蓋率則應(yīng)放置在coverage字段。detail字段的值為一個JSON，包含每次用例的輸入和輸出，分別存放于input和output字段中。
• 提示詞2：將測試報(bào)告整理為JSON格式，具體格式參照輸入報(bào)告。

```
…報(bào)告內(nèi)容略…

應(yīng)輸出的數(shù)據(jù)如下。請根據(jù)此示例生成測試報(bào)告。

[
{
“name”: “超出有效頁碼范圍時，應(yīng)返回空列表并提示無更多數(shù)據(jù)”,
“duration”: 3434,
“coverage”: 80,
“detail”: [
{
“input”: “…”,
“output”: “…”
}
]
}
]

### 為模型設(shè)定身份

與單純的提問相比，預(yù)先向模型提供身份信息能夠有效提升生成結(jié)果的穩(wěn)定性和準(zhǔn)確性。以生成測試用例為例，首先打開接口文檔文件，全面選取文件內(nèi)容，然后在問答區(qū)域進(jìn)行提問。對比下述兩種提示詞，后者能夠生成質(zhì)量更高且覆蓋率更好的用例。

- 提示詞1：請根據(jù)以下接口文檔生成相應(yīng)的測試用例。
- 提示詞2：您是一位經(jīng)驗(yàn)豐富的測試工程師，具備對細(xì)節(jié)的高度敏感性，并能夠高效識別潛在問題及邊界情況。請根據(jù)以下接口文檔生成詳盡的測試用例，以確保所有預(yù)期功能行為均得到驗(yàn)證。

> **說明**：由于優(yōu)質(zhì)的提示詞通常需要輸入較多內(nèi)容，因此這一部分的技巧與通義靈碼即將推出的自定義提示詞功能結(jié)合使用較為合適。在當(dāng)前階段，用戶可以選擇手動輸入或?qū)⑻釂柲０鍙?fù)制粘貼到問題中進(jìn)行編輯。