JetBrains IDEs/Android Studio 插件配置指南

以 IntelliJ IDEA 配置為例。

1. 查看快捷鍵
操作 macOS Windows
代碼補(bǔ)全 - 接受全部建議 Tab Tab
代碼補(bǔ)全 - 廢棄建議 esc Esc
代碼補(bǔ)全增強(qiáng) ? + I Alt + I
"代碼補(bǔ)全單行"模式： 多行補(bǔ)全 ? + M Alt + M
喚醒智能問(wèn)答窗口 ? + ? + / Ctrl + Alt + /
喚醒內(nèi)聯(lián)操作窗口 ? + K Alt + K
喚醒問(wèn)題快速修復(fù) ? + Enter Alt + Enter

2. 配置快捷鍵

在打開 IntelliJ IDEA 的設(shè)置界面，在“按鍵映射”中插件模塊找到 JiHu-GitLab CR，找到對(duì)應(yīng)的指令右鍵調(diào)出設(shè)置框，輸入對(duì)應(yīng)的快捷鍵并確認(rèn)。

3. 配置快捷指令

CodeRider 支持用戶自定義快捷指令，并支持對(duì)快捷指令的修改、刪除操作。

1、創(chuàng)建指令：用戶可以在對(duì)話界面的引導(dǎo)頁(yè)中，單擊“創(chuàng)建指令”?；蛘咴凇爸噶睢苯缑?#xff0c;單擊“創(chuàng)建指令”。隨后，根據(jù)提示輸入指令名稱、指令描述（可選）、提示詞。請(qǐng)注意，指令名稱不可超過(guò)20個(gè)字符，且不可與已存在指令重復(fù)。指令描述內(nèi)容不可超過(guò)50個(gè)字符。提示詞應(yīng)盡量簡(jiǎn)介、清晰，如有復(fù)雜任務(wù)請(qǐng)將任務(wù)進(jìn)行拆解，字?jǐn)?shù)不得超過(guò)1000個(gè)字符。
2、修改、刪除指令：在“指令”界面，用戶將鼠標(biāo)懸浮至對(duì)應(yīng)的指令面板上，會(huì)呈現(xiàn)“編輯”和“刪除的”按鈕，單擊并根據(jù)提示完成相應(yīng)的操作。注：僅支持對(duì)自定義指令的修改、刪除操作。
3、隱藏官方指令：若為方便用戶快速定位到自定義的指令，提供“隱藏官方指令”選項(xiàng)，選中時(shí)將僅顯示自定義指令。


4. 配置代碼補(bǔ)全模式
您可以在 IntelliJ IDEA “設(shè)置”界面點(diǎn)擊“CodeRider”進(jìn)入模型配置界面，可以在 CodeRider “設(shè)置”面板中選擇是否啟用代碼補(bǔ)全，以及代碼補(bǔ)全的模式。

代碼補(bǔ)全模式的說(shuō)明：
1、代碼補(bǔ)全增強(qiáng)：當(dāng)項(xiàng)目代碼豐富時(shí)，允許使用企業(yè)知識(shí)庫(kù)代碼補(bǔ)全檢索增強(qiáng)技術(shù)。
a.開啟該模式時(shí)，請(qǐng)確保當(dāng)前項(xiàng)目代碼倉(cāng)已被創(chuàng)建為代碼知識(shí)庫(kù)，否則該功能無(wú)效。
b.該功能目前只參考當(dāng)前代碼文件知識(shí)庫(kù)，暫不支持跨云端項(xiàng)目倉(cāng)感知。
2、代碼補(bǔ)全單行模式：
a.開啟后，默認(rèn)代碼為逐行補(bǔ)全，若需顯示多行建議，請(qǐng)使用快捷鍵option+M（Mac）或 Alt+M（Windows）觸發(fā)，快捷鍵支持用戶自定義。
b.若不開啟，默認(rèn)補(bǔ)全多行代碼建議。
3、跨文件感知代碼補(bǔ)全上下文：
a.開啟后，將根據(jù)跨文件的代碼內(nèi)容生成代碼補(bǔ)全建議，適用于補(bǔ)全與其他代碼文件相關(guān)性較大的場(chǎng)景。
b.若不開啟，僅根據(jù)當(dāng)前代碼文件上下文生成代碼補(bǔ)全建議，適用于需補(bǔ)全代碼與其他代碼文件內(nèi)容無(wú)關(guān)的場(chǎng)景。

5. 配置代碼補(bǔ)全延時(shí)

為適應(yīng)不同開發(fā)者的編程習(xí)慣，CodeRider 支持在“設(shè)置”界面配置代碼補(bǔ)全延時(shí)觸發(fā)時(shí)間。若您日常開發(fā)中希望 CodeRider 盡可能快速地補(bǔ)全代碼，請(qǐng)?jiān)O(shè)置較短的補(bǔ)全延時(shí)。 > 注意：可配置的補(bǔ)全延時(shí)時(shí)間最小值為200ms，最大值為2s。

6. 配置模型

在 IntelliJ IDEA “設(shè)置”界面點(diǎn)擊“CodeRider”進(jìn)入模型配置界面，在“對(duì)話”和“代碼補(bǔ)全”模塊下分別選擇是否下載本地模型，以及對(duì)應(yīng)功能默認(rèn)使用的模型引擎。此外，您可在對(duì)話界面單獨(dú)設(shè)置您的對(duì)話模型。

注：當(dāng)您選擇允許下載本地代碼補(bǔ)全模型、本地對(duì)話模型時(shí)，以下是桌面?zhèn)€人電腦或者筆記本電腦的推薦配置：

  Intel/AMD CPU + 英偉達(dá) GPU 卡（顯存8GB及以上）Intel/AMD CPU + AMD GPU 卡（顯存8GB及以上）Apple Silicon M1/M2/M3（統(tǒng)一內(nèi)存16GB及以上）操作系統(tǒng)：Windows 10/11、Linux（主流發(fā)布版）、MacOS磁盤空間：不低于 50GB 硬盤空間，固態(tài)硬盤性能更佳

7. 設(shè)置生成提交信息語(yǔ)言

CodeRider 支持生成中文、英文的提交信息，您可在“詳細(xì)設(shè)置”中配置。

8. 配置對(duì)話語(yǔ)言模式

CodeRider 支持生成中文、英文的對(duì)話回復(fù)內(nèi)容，您可在“詳細(xì)設(shè)置”中配置。

9. 配置知識(shí)庫(kù)

CodeRider 的知識(shí)庫(kù)功能權(quán)限依賴于 GitLab 項(xiàng)目權(quán)限，擁有項(xiàng)目“維護(hù)者”及以上權(quán)限的用戶，可以將對(duì)應(yīng)的 GitLab 項(xiàng)目創(chuàng)建、更新和刪除對(duì)應(yīng)知識(shí)庫(kù)；擁有項(xiàng)目“訪客”及以上權(quán)限的用戶，可以調(diào)用該知識(shí)庫(kù)，但無(wú)法對(duì)知識(shí)庫(kù)進(jìn)行創(chuàng)建和刪除操作。（注意：首次創(chuàng)建知識(shí)庫(kù)時(shí)可能需要稍作等待，在等待過(guò)程中您可通過(guò)“刷新”按鈕確認(rèn)知識(shí)庫(kù)的創(chuàng)建狀態(tài)。）

當(dāng)知識(shí)庫(kù)對(duì)應(yīng)的項(xiàng)目在 GitLab 平臺(tái)被更新后，您可以手動(dòng)觸發(fā)“更新知識(shí)庫(kù)”以同步更新。

目前，CodeRider 支持文檔和代碼兩種類型，為保障您的體驗(yàn)效果，在創(chuàng)建知識(shí)庫(kù)時(shí)請(qǐng)按需選擇，同時(shí)確保您單個(gè)文件小于 10 MB。關(guān)于已支持的文件類型，請(qǐng)參考：

 “文檔”類型的知識(shí)庫(kù)，目前已支持的文件類型為 .txt、 .doc、 .docx、 .ppt、 .pptx、 .md、 .mdx、 .pdf (experimental), .yaml, .yml?！按a”類型的知識(shí)庫(kù)，目前已支持的文件類型為 Python(.py)、Go（.go）、Ruby（.rb）、JavaScript(.js)、TypeScript（.ts）、Java(.java)、CPP(.cpp,.cc)、C(.h,.c)、C#(.cs)、Rust(.rs)、Kotlin(.kt)、HTML(.html)、CSS(.css)、SQL(.sql)。

注：
SaaS 免費(fèi)用戶單個(gè)知識(shí)庫(kù)文件數(shù)上限為500個(gè)，付費(fèi)用戶單個(gè)知識(shí)庫(kù)文件數(shù)上限為1000個(gè)。
創(chuàng)建、更新知識(shí)庫(kù)時(shí)可能需要稍作等待，在等待過(guò)程中您可通過(guò)“刷新”按鈕確認(rèn)知識(shí)庫(kù)的創(chuàng)建、更新狀態(tài)。