通義靈碼操作指南——插件使用指南
點擊鏈接,立即下載通義靈碼插件:https://tongyi.aliyun.com/lingma/
通義靈碼,作為智能編碼助手,可以在你進行編碼工作時,為你提供行級/函數(shù)級實時續(xù)寫、注釋生成代碼、單元測試生成、代碼優(yōu)化、注釋生成、代碼解釋、研發(fā)智能問答、代碼問題修復等輔助編碼工作的功能。
說明:在 IDE 環(huán)境中使用通義靈碼,需要先完成通義靈碼插件安裝及阿里云賬號登錄。詳細信息可查看下載安裝指南。
代碼智能補全
行級/函數(shù)級實時補全
當你在 IDE 編輯器區(qū)進行代碼編寫時,在開啟自動云端生成的模式下,通義靈碼會根據(jù)當前代碼文件及相關(guān)代碼文件的上下文,自動為你生成行級/函數(shù)級的代碼建議,此時你可以使用快捷鍵采納、廢棄,或查看不同的代碼建議。
同時,當你在編碼的過程中,也可以通過快捷鍵 ? P 手動觸發(fā)生成代碼建議。

編輯器中代碼建議相關(guān)操作的快捷鍵如下:

Tips:不同操作系統(tǒng)的快捷鍵配置可查看插件配置指南。
自然語言生成代碼
在編輯器中,可以直接通過自然語言的方式描述需要實現(xiàn)的需求,通義靈碼可以在編輯器中生成代碼建議,單擊 Tab 可直接采納。

研發(fā)智能問答
使用通義靈碼的智能問答時,為了通義靈碼與你的對話能夠更友好、高效,希望你能夠在輸入問題時:
- 選中代碼,開始輸入你的問題,通義靈碼將圍繞著選中代碼與你開展對話;
- 精準表達問題,以及給出相對詳細的上下文輸入, 比如選中的代碼、日志、報錯信息等;
- 多多互動,告訴通義靈碼,所給出代碼建議或回答是否滿足你的預期,或生成內(nèi)容存在的具體瑕疵,通義靈碼也會不斷改進。
研發(fā)自由問答
當你編碼遇到問題,缺乏具體解決思路時,可單擊 IDE 側(cè)邊工具導航或使用? ? L喚起通義靈碼智能問答助手,無需離開 IDE 客戶端,即可快速獲得答案和解決思路。

代碼問答
當你對某段代碼有疑問或期望針對代碼進行一些問題解決時,選中代碼后,在智能問答窗口的輸入框中輸入你的問題,通義靈碼將圍繞選中代碼與你開展對話。

@workspace 本地工程問答
當你需要快速了解一個工程、查找工程內(nèi)的實現(xiàn)邏輯,或有新的訴求需要進行代碼變更時,可以在智能問答窗口中通過 @ 可喚起 @workspace,選中后輸入你的問題或訴求,通義靈碼可快速結(jié)合當前倉庫進行工程理解、代碼查詢、代碼問答等,同時可以通過自然語言描述需求,結(jié)合當前工程生成簡單需求或缺陷的整體修改建議和相關(guān)建議代碼。

@terminal 問答
當你遇到執(zhí)行指令不知道如何寫,或者不清楚某個指令的意思時,可以在智能問答窗口中通過 @ 可喚起 @terminal,選擇后使用自然語言描述你的需要指令訴求,通義靈碼將可以生成你需要的命令。生成指令后,你可以一鍵插入到 teminal 中進行執(zhí)行或讓通義靈碼繼續(xù)解釋。當然,你也可以在選擇 @terminal 后,輸入指令讓通義靈碼生成指令解釋。

#team docs 知識庫問答(企業(yè)版)
當你需要結(jié)合企業(yè)內(nèi)私域知識信息讓通義靈碼進行回答時,可以在智能問答窗口中通過 # 喚起 #team docs,并輸入問題,通義靈碼將結(jié)合企業(yè)知識庫(當前用戶有權(quán)限的知識庫)對問題進行回答,在回復中也可以單擊查看引用的企業(yè)知識庫內(nèi)容。

清空會話上下文歷史記憶
當你在會話中是,在智能問答輸入框中輸入 / 即可看到 /clear context 指令,選擇后即可清空當前會話的上下文歷史記憶。

新建會話
在智能問答窗口中,單擊右上角的新建按鈕即可新建會話窗口,單擊后會話窗口將回到默認狀態(tài)。

查看會話歷史
歷史會話功能幫助你檢索和回顧與通義靈碼的交流記錄,方便針對多次的建議進行對比和選擇。不管你在哪個 IDE 客戶端上、哪個工程中,均可以查看或搜索你和通義靈碼的歷史會話。

智能生成指令
指令觸發(fā)方式
通義靈碼提供多處觸發(fā)單元測試生成、代碼解釋、生成代碼注釋、代碼優(yōu)化功能的入口,當你選中的代碼后,有 3 種觸發(fā)方式:
- 在編輯器中,單擊右鍵找到通義靈碼功能操作入口,單擊對應功能操作;
- 在智能問答中,直接單擊對應功能操作;
- 在智能問答中,使用 / 查看快捷指令,單擊對應功能操作。

當需要針對一個方法實現(xiàn)生成單元測試、代碼注釋、代碼解釋、代碼優(yōu)化時,無需選中代碼,可直接單擊函數(shù)上方的快捷入口觸發(fā)相關(guān)功能操作。

選擇指令后輸入回答要求
當你選中代碼后,并通過在智能問答窗口的輸入框輸入 / 的方式選中指令后,可以繼續(xù)輸入附加的要求,比如:
- 選擇 /generate unit test后,繼續(xù)輸入你對單元測試生成的要求,比如使用 JUnit 5生成;
- 選擇 /generate comment后,繼續(xù)輸入生成注釋的要求,比如開頭標明日期,并用英文注釋。

指令一:解釋代碼
覆蓋各種編程語言,選中代碼后可自動識別編程語言并生成代碼解釋。跨越語言的邊界,讓你閱讀代碼更高效。

指令二:生成單元測試
支持根據(jù) JUnit、Mockito、Spring Test、unit test、pytest 等框架生成單元測試。

指令三:生成注釋
一鍵生成方法注釋及行間注釋,節(jié)省你寫代碼注釋的時間,并能夠有效提升代碼可讀性。

指令四:代碼優(yōu)化
深度分析代碼及其上下文,迅速識別潛在的編碼問題,從簡單的語法錯誤到復雜的性能瓶頸,均能夠指出問題所在,并提供具體的優(yōu)化建議代碼。

生成回答后快捷操作
針對不同的指令生成回答后,在智能問答區(qū)中,可以繼續(xù)根據(jù)訴求進行操作,不同功能的對應操作如下:
-
生成單元測試:
- 采納單元測試代碼建議:支持一鍵插入、復制、或者新建代碼文件,可快速采納生成的單元測試代碼建議;
- 更換單元測試框架:提供基于 JUnit、Mockito、Spring Test、unit test、pytest 等框架生成單元測試代碼建議,在回答完成后,可以根據(jù)需要切換框架重新生成;
- 新建文件:支持一鍵保存單元測試代碼為新文件,方便進行查看和修改。
-
生成代碼優(yōu)化建議
- 采納代碼優(yōu)化建議:針對優(yōu)化建議中的建議代碼,支持一鍵插入、復制,快速采納生成的建議代碼;
- 查看 Diff:單擊查看 Diff 按鈕,將快速喚起 IDE Diff 查看窗口,快速了解建議和源代碼的變更;
-
生成代碼注釋:
- 采納代碼注釋建議:支持一鍵插入、復制,可快速采納生成的代碼注釋建議;
- 查看 Diff:單擊查看 Diff 按鈕,將快速喚起 IDE Diff 查看窗口,快速了解建議和源代碼的變更。
-
解釋代碼:
- 支持重試、更詳細、更簡單、中文/英文解釋的追問。
問題修復建議
代碼問題(Problem)一鍵修復
當你在編碼過程中出現(xiàn)代碼問題(Problem)需要進行修復時,通義靈碼可以一鍵給出修復建議,幫你快速修復代碼問題。可以通過編輯器中報錯圖標中下拉菜單中或 Problem 窗口中聚焦到報錯信息后右鍵菜單中,單擊通義靈碼一鍵修復菜單,即可生成修復建議和相關(guān)建議代碼。

異常報錯排查(IntelliJ IDEA)
在 IntelliJ IDEA 中,當運行出現(xiàn)異常報錯時,在運行標準輸出窗口中,即可看到通義靈碼的快捷操作按鈕,單擊后,通義靈碼將結(jié)合運行代碼、異常堆棧等報錯上下文,快速給出排查思路或修復建議。

執(zhí)行報錯、編譯報錯排查(Visual Studio Code)
在 Visual Studio Code 中,當 terminal 中執(zhí)行指令后報錯、編譯或運行后有大量報錯,需要進行解釋或修復時,可以選中報錯信息,右鍵選擇使用通義靈碼一鍵解釋,也會為你生成相關(guān)命令解釋及問題解決建議。

提交信息生成
當你有代碼變更需要提交,需要寫提交信息時,可以通過通義靈碼一鍵生成 Git 提交信息,同時可以在插件設(shè)置中配置生成的語言(英文/中文)。

離線單行補全
通義靈碼代碼補全默認使用云端大模型進行智能續(xù)寫,當網(wǎng)絡(luò)情況有限制時,可使用本地補全模式,單擊狀態(tài)欄圖標切換至本地補全模式后,編輯器中進行編碼時,通義靈碼會給出單行的代碼建議。

IntelliJ IDEA 中技術(shù)文檔和代碼片段搜索
在 IntelliJ IDEA 客戶端內(nèi),如果你在編碼過程中有需要進行技術(shù)資料檢索、代碼片段搜索時,無須離開 IDE,單擊側(cè)邊導航的通義靈碼,單擊搜索,即可開始搜索。

查看幫助和分享反饋
查看使用幫助
通義靈碼的智能問答窗口中,可以通過 2 種方式查看使用幫助:
- 通過智能問答的 /help 指令快捷查看使用幫助;

- 單擊智能問答窗口的幫助文檔入口,可以快速來到當前幫助文檔知識庫。

反饋回答質(zhì)量
在智能問答中,你可以對通義靈碼所生成的回答內(nèi)容進行評價,支持點贊和點踩,以不斷優(yōu)化回答效果。

使用問題反饋
當你在使用的過程有任何疑問、優(yōu)化建議、功能訴求等,均可在通義靈碼的智能問答窗口單擊提交反饋,即可前往阿里云開發(fā)者社區(qū)-通義靈碼問答專區(qū)向我們提出問題。

參與體驗調(diào)研
為了給你提供更好的智能編碼體驗,我們也期待收到你的使用體驗反饋、優(yōu)化建議以及你的期待,我們會不斷努力和優(yōu)化產(chǎn)品體驗。


浙公網(wǎng)安備 33010602011771號