插件使用指南
通義靈碼,作為智能編碼助手,可以在你進(jìn)行編碼工作時(shí),為你提供行級(jí)/函數(shù)級(jí)實(shí)時(shí)續(xù)寫、注釋生成代碼、單元測(cè)試生成、代碼優(yōu)化、注釋生成、代碼解釋、研發(fā)智能問(wèn)答、代碼問(wèn)題修復(fù)等輔助編碼工作的功能。
在 IDE 環(huán)境中使用通義靈碼,需要先完成通義靈碼插件安裝及阿里云賬號(hào)登錄。詳細(xì)信息可查看下載安裝指南。
代碼智能補(bǔ)全
行級(jí)/函數(shù)級(jí)實(shí)時(shí)補(bǔ)全
當(dāng)你在 IDE 編輯器區(qū)進(jìn)行代碼編寫時(shí),在開啟自動(dòng)云端生成的模式下,通義靈碼會(huì)根據(jù)當(dāng)前代碼文件及相關(guān)代碼文件的上下文,自動(dòng)為你生成行級(jí)/函數(shù)級(jí)的代碼建議,此時(shí)你可以使用快捷鍵采納、廢棄,或查看不同的代碼建議。
同時(shí),當(dāng)你在編碼的過(guò)程中,也可以通過(guò)快捷鍵 ?
P
手動(dòng)觸發(fā)生成代碼建議。
編輯器中代碼建議相關(guān)操作的快捷鍵如下:
操作 | macOS | Windows |
接受行間代碼建議 |
|
|
廢棄行間代碼建議 |
|
|
查看上一個(gè)行間推薦結(jié)果 |
|
|
查看下一個(gè)行間推薦結(jié)果 |
|
|
手動(dòng)觸發(fā)行間代碼建議 |
|
|
Tips:不同操作系統(tǒng)的快捷鍵配置可查看插件配置指南。
自然語(yǔ)言生成代碼
在編輯器中,可以直接通過(guò)自然語(yǔ)言的方式描述需要實(shí)現(xiàn)的需求,通義靈碼可以在編輯器中生成代碼建議,單擊 Tab
可直接采納。
研發(fā)智能問(wèn)答
使用通義靈碼的智能問(wèn)答時(shí),為了通義靈碼與你的對(duì)話能夠更友好、高效,希望你能夠在輸入問(wèn)題時(shí):
選中代碼,開始輸入你的問(wèn)題,通義靈碼將圍繞著選中代碼與你開展對(duì)話;
精準(zhǔn)表達(dá)問(wèn)題,以及給出相對(duì)詳細(xì)的上下文輸入, 比如選中的代碼、日志、報(bào)錯(cuò)信息等;
多多互動(dòng),告訴通義靈碼,所給出代碼建議或回答是否滿足你的預(yù)期,或生成內(nèi)容存在的具體瑕疵,通義靈碼也會(huì)不斷改進(jìn)。
研發(fā)自由問(wèn)答
當(dāng)你編碼遇到問(wèn)題,缺乏具體解決思路時(shí),可單擊 IDE 側(cè)邊工具導(dǎo)航或使用?
?
L
喚起通義靈碼智能問(wèn)答助手,無(wú)需離開 IDE 客戶端,即可快速獲得答案和解決思路。
代碼問(wèn)答
當(dāng)你對(duì)某段代碼有疑問(wèn)或期望針對(duì)代碼進(jìn)行一些問(wèn)題解決時(shí),選中代碼后,在智能問(wèn)答窗口的輸入框中輸入你的問(wèn)題,通義靈碼將圍繞選中代碼與你開展對(duì)話。
@workspace 本地工程問(wèn)答
當(dāng)你需要快速了解一個(gè)工程、查找工程內(nèi)的實(shí)現(xiàn)邏輯,或有新的訴求需要進(jìn)行代碼變更時(shí),可以在智能問(wèn)答窗口中通過(guò) @
可喚起 @workspace
,選中后輸入你的問(wèn)題或訴求,通義靈碼可快速結(jié)合當(dāng)前倉(cāng)庫(kù)進(jìn)行工程理解、代碼查詢、代碼問(wèn)答等,同時(shí)可以通過(guò)自然語(yǔ)言描述需求,結(jié)合當(dāng)前工程生成簡(jiǎn)單需求或缺陷的整體修改建議和相關(guān)建議代碼。
@terminal 問(wèn)答
當(dāng)你遇到執(zhí)行指令不知道如何寫,或者不清楚某個(gè)指令的意思時(shí),可以在智能問(wèn)答窗口中通過(guò) @
可喚起 @terminal
,選擇后使用自然語(yǔ)言描述你的需要指令訴求,通義靈碼將可以生成你需要的命令。生成指令后,你可以一鍵插入到 terminal 中進(jìn)行執(zhí)行或讓通義靈碼繼續(xù)解釋。當(dāng)然,你也可以在選擇 @terminal
后,輸入指令讓通義靈碼生成指令解釋。
#teamDocs 知識(shí)庫(kù)問(wèn)答(企業(yè)版)
當(dāng)你需要結(jié)合企業(yè)內(nèi)私域知識(shí)信息讓通義靈碼進(jìn)行回答時(shí),可以在智能問(wèn)答窗口中通過(guò) #
喚起 #teamDocs
,并輸入問(wèn)題,通義靈碼將結(jié)合企業(yè)知識(shí)庫(kù)(當(dāng)前用戶有權(quán)限的知識(shí)庫(kù))對(duì)問(wèn)題進(jìn)行回答,在回復(fù)中也可以單擊查看引用的企業(yè)知識(shí)庫(kù)內(nèi)容。
清空會(huì)話上下文歷史記憶
當(dāng)你在會(huì)話中是,在智能問(wèn)答輸入框中輸入 /
即可看到 /clear context
指令,選擇后即可清空當(dāng)前會(huì)話的上下文歷史記憶。
新建會(huì)話
在智能問(wèn)答窗口中,單擊右上角的新建按鈕即可新建會(huì)話窗口,單擊后會(huì)話窗口將回到默認(rèn)狀態(tài)。
查看會(huì)話歷史
歷史會(huì)話功能幫助你檢索和回顧與通義靈碼的交流記錄,方便針對(duì)多次的建議進(jìn)行對(duì)比和選擇。不管你在哪個(gè) IDE 客戶端上、哪個(gè)工程中,均可以查看或搜索你和通義靈碼的歷史會(huì)話。
智能生成指令
指令觸發(fā)方式
通義靈碼提供多處觸發(fā)單元測(cè)試生成、代碼解釋、生成代碼注釋、代碼優(yōu)化功能的入口,當(dāng)你選中的代碼后,有 3 種觸發(fā)方式:
在編輯器中,單擊右鍵找到通義靈碼功能操作入口,單擊對(duì)應(yīng)功能操作;
在智能問(wèn)答中,直接單擊對(duì)應(yīng)功能操作;
在智能問(wèn)答中,使用
/
查看快捷指令,單擊對(duì)應(yīng)功能操作。
當(dāng)需要針對(duì)一個(gè)方法實(shí)現(xiàn)生成單元測(cè)試、代碼注釋、代碼解釋、代碼優(yōu)化時(shí),無(wú)需選中代碼,可直接單擊函數(shù)上方的快捷入口觸發(fā)相關(guān)功能操作。
選擇指令后輸入回答要求
當(dāng)你選中代碼后,并通過(guò)在智能問(wèn)答窗口的輸入框輸入 / 的方式選中指令后,可以繼續(xù)輸入附加的要求,比如:
選擇
/generate unit test
后,繼續(xù)輸入你對(duì)單元測(cè)試生成的要求,比如使用 JUnit 5生成
;選擇
/generate comment
后,繼續(xù)輸入生成注釋的要求,比如開頭標(biāo)明日期,并用英文注釋
。
指令一:解釋代碼
覆蓋各種編程語(yǔ)言,選中代碼后可自動(dòng)識(shí)別編程語(yǔ)言并生成代碼解釋。跨越語(yǔ)言的邊界,讓你閱讀代碼更高效。
指令二:生成單元測(cè)試
支持根據(jù) JUnit、Mockito、Spring Test、unit test、pytest 等框架生成單元測(cè)試。
指令三:生成注釋
一鍵生成方法注釋及行間注釋,節(jié)省你寫代碼注釋的時(shí)間,并能夠有效提升代碼可讀性。
指令四:代碼優(yōu)化
深度分析代碼及其上下文,迅速識(shí)別潛在的編碼問(wèn)題,從簡(jiǎn)單的語(yǔ)法錯(cuò)誤到復(fù)雜的性能瓶頸,均能夠指出問(wèn)題所在,并提供具體的優(yōu)化建議代碼。
生成回答后快捷操作
針對(duì)不同的指令生成回答后,在智能問(wèn)答區(qū)中,可以繼續(xù)根據(jù)訴求進(jìn)行操作,不同功能的對(duì)應(yīng)操作如下:
生成單元測(cè)試:
采納單元測(cè)試代碼建議:支持一鍵插入、復(fù)制、或者新建代碼文件,可快速采納生成的單元測(cè)試代碼建議;
更換單元測(cè)試框架:提供基于 JUnit、Mockito、Spring Test、unit test、pytest 等框架生成單元測(cè)試代碼建議,在回答完成后,可以根據(jù)需要切換框架重新生成;
新建文件:支持一鍵保存單元測(cè)試代碼為新文件,方便進(jìn)行查看和修改。
生成代碼優(yōu)化建議
采納代碼優(yōu)化建議:針對(duì)優(yōu)化建議中的建議代碼,支持一鍵插入、復(fù)制,快速采納生成的建議代碼;
查看 Diff:?jiǎn)螕舨榭?Diff 按鈕,將快速喚起 IDE Diff 查看窗口,快速了解建議和源代碼的變更;
生成代碼注釋:
采納代碼注釋建議:支持一鍵插入、復(fù)制,可快速采納生成的代碼注釋建議;
查看 Diff:?jiǎn)螕舨榭?Diff 按鈕,將快速喚起 IDE Diff 查看窗口,快速了解建議和源代碼的變更。
解釋代碼:
支持重試、更詳細(xì)、更簡(jiǎn)單、中文/英文解釋的追問(wèn)。
問(wèn)題修復(fù)建議
代碼問(wèn)題(Problem)一鍵修復(fù)
當(dāng)你在編碼過(guò)程中出現(xiàn)代碼問(wèn)題(Problem)需要進(jìn)行修復(fù)時(shí),通義靈碼可以一鍵給出修復(fù)建議,幫你快速修復(fù)代碼問(wèn)題。可以通過(guò)編輯器中報(bào)錯(cuò)圖標(biāo)中下拉菜單中或 Problem 窗口中聚焦到報(bào)錯(cuò)信息后右鍵菜單中,單擊通義靈碼一鍵修復(fù)菜單,即可生成修復(fù)建議和相關(guān)建議代碼。
異常報(bào)錯(cuò)排查(IntelliJ IDEA)
在 IntelliJ IDEA 中,當(dāng)運(yùn)行出現(xiàn)異常報(bào)錯(cuò)時(shí),在運(yùn)行標(biāo)準(zhǔn)輸出窗口中,即可看到通義靈碼的快捷操作按鈕,單擊后,通義靈碼將結(jié)合運(yùn)行代碼、異常堆棧等報(bào)錯(cuò)上下文,快速給出排查思路或修復(fù)建議。
執(zhí)行報(bào)錯(cuò)、編譯報(bào)錯(cuò)排查(Visual Studio Code)
在 Visual Studio Code 中,當(dāng) terminal 中執(zhí)行指令后報(bào)錯(cuò)、編譯或運(yùn)行后有大量報(bào)錯(cuò),需要進(jìn)行解釋或修復(fù)時(shí),可以選中報(bào)錯(cuò)信息,右鍵選擇使用通義靈碼一鍵解釋,也會(huì)為你生成相關(guān)命令解釋及問(wèn)題解決建議。
提交信息生成
當(dāng)你有代碼變更需要提交,需要寫提交信息時(shí),可以通過(guò)通義靈碼一鍵生成 Git 提交信息,同時(shí)可以在插件設(shè)置中配置生成的語(yǔ)言(英文/中文)。
離線單行補(bǔ)全
通義靈碼代碼補(bǔ)全默認(rèn)使用云端大模型進(jìn)行智能續(xù)寫,當(dāng)網(wǎng)絡(luò)情況有限制時(shí),可使用本地補(bǔ)全模式,單擊狀態(tài)欄圖標(biāo)切換至本地補(bǔ)全模式后,編輯器中進(jìn)行編碼時(shí),通義靈碼會(huì)給出單行的代碼建議。
IntelliJ IDEA 中技術(shù)文檔和代碼片段搜索
在 IntelliJ IDEA 客戶端內(nèi),如果你在編碼過(guò)程中有需要進(jìn)行技術(shù)資料檢索、代碼片段搜索時(shí),無(wú)須離開 IDE,單擊側(cè)邊導(dǎo)航的通義靈碼,單擊搜索,即可開始搜索。
查看幫助和分享反饋
查看使用幫助
通義靈碼的智能問(wèn)答窗口中,可以通過(guò) 2 種方式查看使用幫助:
通過(guò)智能問(wèn)答的
/help
指令快捷查看使用幫助;
單擊智能問(wèn)答窗口的幫助文檔入口,可以快速來(lái)到當(dāng)前幫助文檔知識(shí)庫(kù)。
反饋回答質(zhì)量
在智能問(wèn)答中,你可以對(duì)通義靈碼所生成的回答內(nèi)容進(jìn)行評(píng)價(jià),支持點(diǎn)贊和點(diǎn)踩,以不斷優(yōu)化回答效果。
使用問(wèn)題反饋
當(dāng)你在使用的過(guò)程有任何疑問(wèn)、優(yōu)化建議、功能訴求等,均可在通義靈碼的智能問(wèn)答窗口單擊提交反饋,即可前往阿里云開發(fā)者社區(qū)-通義靈碼問(wèn)答專區(qū)向我們提出問(wèn)題。
參與體驗(yàn)調(diào)研
為了給你提供更好的智能編碼體驗(yàn),我們也期待收到你的使用體驗(yàn)反饋、優(yōu)化建議以及你的期待,我們會(huì)不斷努力和優(yōu)化產(chǎn)品體驗(yàn)。