CodeArts 编码智能助手 VSCode插件安装使用指南
CodeArts 编码智能助手简介
CodeArts 编码智能助手致力于打造现代化开发新范式, 通过将自然语言转化为规范可阅读/无开源漏洞的编程语言, 提升开发者编码效率, 助力企业快速响应市场不确定性。
基础特性
- 代码生成
- 研发问答
- 代码注释
- 代码调试
- 单元测试
- 代码解释
- 代码优化
插件特性
- 在问答框自由问答
- 编码中停顿时自动触发（默认关闭，需在设置中打开）
- 任意时刻主动触发
快捷键
- @: 在输入框中使用智能体
- /: 在输入框中使用提示词
- #：在输入框中选择知识库内容
- Alt(Option)+U：打开问答对话框
- Enter：在函数/方法签名下触发自动生成
- Tab：接纳代码生成结果
- Esc：取消代码生成
- Alt(Option)+]：查看下一个推荐
- Alt(Option)+[：查看上一个推荐
- Alt(Option)+C：主动触发多行代码生成
- Alt(Option)+X：主动触发单行代码生成
- Alt(Option)+R：重新生成代码
- Ctrl+Shift+Q：将代码添加到聊天窗
快捷指令
- /explain: 解释选中的代码
- /comment: 为选中的代码生成方法注释或行间注释
- /debug: 诊断选中的代码
- /tests: 为选中的代码生成单元测试
- /optimize：优化选中的代码
- /clear: 当你在会话中时，清空上下文记忆
- /help: 学习如何使用CodeArts 编码智能助手
功能介绍
代码生成：在任意位置使用热键 Alt(Option)+C 可以触发多行代码生成；在设置里可打开 回车触发 以及 停顿触发 使用其他功能触发方式。同时也支持代码单行生成，快捷键为Alt + X。（VSCode 1.78.0以及以上版本暂不支持流式生成）
代码解释：选中合适的代码片段，点击右键在“CodeArts 编码智能助手”下选中“代码解释”功能，快速分析代码并自动生成文档，提高阅读代码的速度和效率。
代码注释：选中合适的代码片段，点击右键在“CodeArts 编码智能助手”下选中“代码注释”功能，快速分析代码，自动生成有意义的完整注释，增加代码可读性，同一个代码库注释风格的一致性，提高研发问题的解决效率。
代码调试：选中合适的代码片段，点击右键在“CodeArts 编码智能助手”下选中“代码调试”功能，调试代码在用户调试运行时，根据提示的错误日志和需要修复的代码，使用大模型生成解决方案，帮助用户解决该问题。
单元测试：选中合适的代码片段，点击右键在“CodeArts 编码智能助手”下选中“单元测试”功能，能够自动创建单元测试用例，提高测试覆盖率，确保每个功能和场景都被测试到。
代码优化：选择需要优化的代码，点击右键在“CodeArts 编码智能助手”下选中代码优化功能，对代码进行检查，并提供优化建议，提升代码质量。
研发知识问答：在交互框中进行研发相关提问，提高研发问题的解决效率。
快捷功能：使用热键 Alt(Option)+U 或打开右边工具栏，点击输入框内敲下“/”可看到快捷功能使用选择。
CodeArts 编码智能助手 服务声明
本服务协议（以下简称“服务协议”、“协议”）将为您介绍在使用本服务时所享有的权利、履行的义务和责任。请您认真阅读、充分理解各条款内容，特别是免除责任、责任限制等影响重大的条款，同时我们已为您以粗体字的形式予以提示。
您理解并同意，您使用本协议中的任何服务即视为您已充分阅读并同意接受本声明中的“通用服务条款”及所使用的服务对应的内容，本协议即对您将产生法律约束力。如您不同意部分或全部协议条款的，请您停止使用相关服务。
通用服务条款
**1.1 缔结主体。本协议由华为云计算技术有限公司（或称“华为”、“华为云”、“我们”）与您（或称“用户”）**共同缔结，一经生效将会在您与我们之间具有法律效力。您确认，您应当是具备完全民事权利能力和与所从事的民事行为相适应的行为能力的自然人、法人或其他组织。若您不具备前述主体资格，请勿使用服务，否则您及您的监护人应承担因此而导致的一切后果，且华为有权注销（永久冻结）您的账户，并向您及您的监护人索偿。如您代表一家公司或其他法律主体进行注册或以其他华为允许的方式实际使用本服务，则您声明和保证，您有权使该公司或该法律主体受本协议的约束
1.2 单独协议。 如果您通过线下订阅本服务、或通过我们的合作伙伴采购本服务，或购买集成本服务的合作伙伴产品，您可能与我们或我们的合作伙伴之间签署单独协议。您承认并同意，如果您被授权或以其他方式访问和使用本服务的，则您将仍受本条所提及的单独协议的约束；如果本协议内容与该单独协议内容冲突的，以单独协议的内容为准。
1.3 **协议变更。**本协议会不定时进行更新，我们将尽商业最大努力通知到您，告知您协议内容的任何重大变更，或者您也可以随时点击访问服务官网，阅读最新版的服务协议。如您不同意最新版服务协议的内容，请您停止使用本服务，如您继续使用，即表示您已了解且同意最新版的服务协议。
1.4 服务的维护。我们可能会不时对服务及相关内容进行应用升级、补丁程序、错误修复或其他维护。我们将就计划维护尽商业最大努力通知到您（紧急维护除外），您同意尽最大合理努力遵守我们通知您的任何维护要求。
1.5 **服务费用。**本服务公测期间，不向用户收取任何费用；商用后，服务费用将在您订购页面予以列明公示，您可自行选择具体服务类型并按列明的价格予以支付。对于特定服务您可选择先付费或后付费。本条未详尽事宜请参见《华为云用户协议》“3.费用及支付”条款https://www.huaweicloud.com/declaration/sa_cua_computing.html
- 1.5.1 先付费。在您付费之后，华为云开始为您提供服务。您未在下单后未立即付费的，订单将为您保留7天；7天届满您仍未付费或者7天内订单所对应的服务售罄或者下架的，订单失效。订单失效后华为云与您就服务所达成的合意失效。服务期满您希望继续使用相关服务的，您至少应在服务期满前支付续费款项，以使服务得以继续进行。
- 1.5.2 后付费。对于部分服务您可先使用后付费。您可以通过https://www.huaweicloud.com/product/price.html查看更新后的价格、付款方式和规则。
- 1.5.3所有的赠送服务项目或优惠活动均为华为云在正常服务价格之外的一次性特别优惠，赠送的服务项目或优惠活动不可折价、冲抵服务价格。具体请参见各具体赠送服务项目或优惠活动的活动规则。
1.6 用户数据
- 1.6.1 “用户数据”是指由您和/或您的最终用户以任何格式在服务过程中传输、存储或处理的所有信息（包括个人信息）、软件、设备、文本、图像、视频、音频、照片、第三方应用程序、材料等数据，您完全拥有您的用户数据。未经您的同意，华为云不会擅自使用和披露您的用户数据。
- 1.6.2 就用户数据，除法律法规要求或者您使用本服务的需要外，华为云仅根据您的授权和指示，以及我们与您的协议处理您的此类数据。
- 1.6.3 您有权对您的用户数据进行上传、删除、更改等操作。就数据的删除、更改等操作，您应谨慎操作并自行承担因此操作而产生的后果。
- 1.6.4 您应根据自身需求自行对数据进行备份，华为云仅依据相关法律法规要求或约定提供数据备份服务。
- 1.6.5 为了提升以及改进本服务的目的，华为云可能会收集、使用某些您使用过程中所产生的信息，例如你是否采纳了我们的推荐结果等。为服务正常运行之必须，华为云可能会短暂的缓存您的代码，但华为云不会长久的储存您采纳的推荐结果的具体代码，也不会长久的储存任何您自行撰写的代码。
1.7 您承诺对您的最终用户负责，若您的最终用户在使用本协议项下相关服务时违反法律法规及相关规定，或者不当使用相关服务给第三方或者华为云造成损害的，您应承担赔偿责任。
1.8 我们的有限承诺。
- 1.8.1 华为云将不断努力提升服务质量和服务水平，但不能保证所提供的服务不发生任何中断或没有任何瑕疵。
- 1.8.2 您理解并同意《华为云用户协议》第4.3条“我们的有限保证”https://www.huaweicloud.com/declaration/sa_cua_computing.html 中我们对SLA的有限承诺。
- 1.8.3 华为云相关服务的提供是基于当时云服务可供应的状态及产品特性，不构成华为云对该云服务达到一定生命周期后长期供应该云服务的承诺。华为云会尽最大商业努力通知您相关服务SLA的修改。
- 1.8.4 尽管有第1.8.2和第1.8.3条之规定，本服务在公测期间应排他性地适用本声明第2.6条关于服务可用性的承诺。
1.9 双方声明。
- 1.9.1 您了解并同意，您使用本服务符合法律法规的要求。**我们仅按照您的指示，为您提供标准服务，并不对您使用本服务的合法合规性负责。**如果我们合理地认为您在使用本服务时有任何行为违反法律、法规或者侵犯第三方权利的行为，或以其他方式违反协议的条款（包括《法律声明》《隐私政策声明》《可接受使用政策》《华为云用户协议》以及其他与华为云官方网站上其他与您相关的协议）（“禁止内容”），我们有权删除禁止内容或禁止您对相关服务的使用或者对相关内容的访问或暂停服务。您同时应赔偿因您的原因给华为云造成的一切损失。
- 1.9.2 华为云仅对华为云服务本身提供运营维护，您应当保证自身的网络、设备的安全性、稳定性，如发生您自身原因或第三方原因导致的任何设备故障、网络中断情况，您应及时解决并避免对华为云服务产生影响。
1.10 免责声明
- 1.10.1您了解并同意，对以下原因导致的相关服务无法继续使用，我们不承担责任。
CodeArts 编码智能助手服务条款
2.1 服务内容
- 华为云提供的智能编码助手是以集成开发环境（IDE）插件的形式，为客户提供代码智能生成能力，帮助客户更快更高效的写出高质量代码。
2.2 您代码中的个人信息
- 为了保证您以及您的最终用户（如有）的个人信息合法权益，您通过本服务上传和留存的代码中不建议包含个人信息。您理解并同意，如您通过本服务上传和留存的代码中包含个人信息，则您作为个人信息处理者，已合法取得相关数据主体的同意和授权，华为云仅根据为您提供本服务之必要处理该个人信息。
2.3 您需要提供的配合
-CodeArts 编码智能助手以集成开发环境（IDE）插件的形式提供服务，因此我们需要您提前安装好指定的集成开发环境。若因您的操作系统或集成开发环境非正版、植入木马而导致数据泄露或其他法律问题，您理解并同意自愿承担相应后果，并确保华为云不会因此遭受任何损失。
2.4 使用限制
2.5 免责声明
- 2.5.1 您应当了解并同意，本服务所为您展示的代码只是“推荐”，在本服务的使用过程中，华为云及本服务并不实际产生或撰写任何代码，若您选择采纳本服务所推荐的代码，应当视为您实际撰写了此代码，您应当是所产生、选择的代码的唯一著作权人，且应当就您的作品承担相应的责任。
- 2.5.2 华为云及本服务不会就服务过程中所推荐的任何代码承担安全、瑕疵、质量、兼容等任何保证责任，无论是明示或暗示。您有责任确保你生成的代码的安全和质量（无论其是由您完全自主撰写或者是采纳了本服务提出的建议）。我们建议您在使用本服务推荐的代码时采取与使用您完全自主编写的代码时相同的预防措施。包括严格的测试、IP扫描和跟踪安全漏洞。
2.6 其他特殊说明
- CodeArts 编码智能助手当前以公测的方式提供服务。公测期间，华为云将免费提供该服务，不收取任何费用，同时对于该服务在公测期间不承诺SLA。
CodeArts Doer for Coding: Installation and User Guide
CodeArts Doer for Coding: Introduction
This CodeArts AI assistant transforms natural language prompts into clean code without open-source vulnerabilities. Ship rock-solid, enterprise-ready code for accelerated feature rollouts so you can stay ahead of market shifts.
Basic Features
- Code generation
- R&D Q&A
- Code commenting
- Code debugging
- Unit testing
- Code explanation
- Code optimization
Benefits
- Get multiple code suggestions right inside your editor as you type.
- Let the extension auto-suggest when you stop typing (opt-in via settings).
- Invoke suggestions anywhere you like.
Shortcuts
- @: Call in agents from the input box.
- /: Fire off slash commands in the input box.
- #: Scope your chat to specific context.
- Alt (Option)+U: Pop open the chat panel.
- Enter: Trigger auto-generation under functions or method signatures.
- Tab: Accept generated code.
- Esc: Cancel code generation.
- Alt (Option)+]: View the next suggestion.
- Alt (Option)+[: View the previous suggestion.
- Alt (Option)+C: Trigger multi-line code generation.
- Alt (Option)+X: Trigger single-line code generation.
- Alt (Option)+R: Regenerate code.
- Ctrl+Shift+Q: Add code to the chat window.
Slash Commands
- /explain: Provide breakdowns for the selected code.
- /comment: Generate method or line comments for the selected code.
- /debug: Diagnose issues in the selected code.
- /tests: Spawn unit tests for the selected code.
- /optimize: Level up the selected code.
- /clear: Flush context memory mid-session.
- /help: Find out how CodeArts Doer for Coding can give you a boost.
Intelligent Functions
Generation
Code Generation: Press Alt (Option)+C for multi-line code. For just one line, press Alt+X. Smart triggers in settings include Enter keystroke and pauses. (Streaming generation is not yet available in VS Code versions 1.78.0 and up.)
Chat
Code explanation: Right-click on a code snippet and choose CodeArts Doer for Coding > Explain Code.
Code commenting: Right-click on a code snippet and choose CodeArts Doer for Coding > Generate Comment.
Code debugging: Right-click on a buggy code snippet and choose Debug Code. Drop your error log into the popup to get back actionable fixes for any runtime error in your IDE.
Unit testing: Right-click on a code snippet and choose CodeArts Doer for Coding > Generate Unit Tests.
Code optimization: Right-click on a code snippet and choose CodeArts Doer for Coding > Optimize Code.
R&D Q&A: Got questions about research, development, or anything in between? Just ask in the chat box.
Quick Functions: Use the shortcut Alt(Option)+U or open the right toolbar, then click inside the input box and press "/" to see the available quick function options.
CodeArts Doer for Coding Service Statement
This Service Agreement ("this Statement", "Service Agreement", or "Agreement" for short) describes your rights, obligations, and responsibilities for your use of CodeArts Doer for Coding ("this Service" for short). Please carefully read and fully understand the terms of this Agreement, especially those highlighted in bold, which may significantly impact your rights. These include limitations and exclusions of liability.
You understand and agree that by using any services in this Agreement, you are deemed to have read and agree to the "General Terms of Service" and the dedicated terms for the service you use. This Agreement then becomes legally binding on you. If you do not agree to some or all of the terms in this Agreement, you shall stop using related services.
1. General Terms of Service
1.1 Contracting Entity: This Agreement is entered into by and between Huawei Cloud Computing Technologies Co., Ltd. (or referred to as "Huawei", "Huawei Cloud", or "We") and you (or "User"). Once this Agreement takes effect, it becomes legally binding on both parties signing it. You acknowledge that you shall be a natural person, legal person, or other organization with full capacity for civil conduct, and may independently carry out civil juristic acts. Do not use this Service without the preceding qualifications. Otherwise, you and your guardian shall bear all consequences caused thereby. In addition, Huawei has the right to cancel (permanently freeze) your account and claim compensation from you and your guardian. If you are registered on behalf of a company or other legal entity or use this Service in a manner permitted by Huawei, you represent and warrant that you are an authorized representative of the company or legal entity to bind such company or legal entity to the terms of this Agreement.
1.2 Separate Agreement: If you subscribe to this Service offline, purchase this Service through our partners, or purchase a partner product that integrates this Service, you may sign a separate agreement with us or our partners. You acknowledge and agree that you will remain bound by the separate agreement mentioned in this article to be authorized to access and use this Service. The separate agreement shall prevail in case of conflicts with this Agreement.
1.3 Changes to This Agreement: This Agreement is subject to change at any time. We will make our best and reasonable efforts to notify you of any major changes to the Agreement, or you can visit our official website and read the latest service agreement. If you do not agree to part or all of the latest Agreement, please stop using this Service. By continuing to use this Service, you acknowledge that you are aware of and agree to the latest Agreement.
1.4 Service Maintenance: We may maintain this Service from time to time through application upgrade, patch installation, or bug fixes. We will make our best, reasonable efforts to notify you of such scheduled maintenance events (except for emergency maintenance). You agree to make your best, reasonable efforts to comply with any notified maintenance requirements.
1.5 Service Pricing: The service is offered for free during the open beta test (OBT). After commercial release, you shall pay the fees for the service types you selected and the listed prices on the subscription page. For specific services, you can choose a prepaid or postpaid plan as your payment type. Any and all unaccomplished matters in this clause shall be subject to Clause 3 "Fees and Payment" in Huawei Cloud Customer Agreement https://www.huaweicloud.com/declaration/sa_cua_computing.html.
- 1.5.1 Prepaid Plan: Huawei Cloud only provides you services with a paid subscription. By default, unpaid orders are held for seven days. If the services or resources in your order are sold out, not paid, or unavailable after the period expires, the order becomes invalid. After an order expires, the agreement reached between Huawei Cloud and you on the service becomes invalid. You shall renew the service before the expiration to ensure continued use.
- 1.5.2 Postpaid Plan: Postpayment is available for certain services. You can view https://www.huaweicloud.com/product/price.html for the updated price, payment method, and rules.
- 1.5.3 All complimentary service items or preferences are one-time special offers. The service fee shall not be offset by these complimentary service items. For details, see the rules for free service items and special offers.
1.6 User Data
- 1.6.1 User Data refers to all information (including personal information), software, devices, text, images, videos, audios, photos, third-party applications, and materials transmitted, stored, or processed by you and/or your end users in any format during the use of services. You have full ownership and control of your User Data. Huawei Cloud will not use or disclose your User Data without your consent.
- 1.6.2 In terms of User Data, except as required by laws and regulations or for your use of this Service, Huawei Cloud processes your data only in accordance with your authorization and instructions and by agreement between you and us.
- 1.6.3 You have the right to upload, delete, and modify your User Data. Exercise caution when deleting or modifying data, as you will bear the consequences of the operations.
- 1.6.4 You shall back up your data as needed. Huawei Cloud provides data backup services only in accordance with relevant laws and regulations.
- 1.6.5 For the purposes of improving this service, we will collect the data during your use of our product, for example, your acceptance of our recommendations. To ensure the normal running of this Service, Huawei Cloud may cache your code for a temporary period. However, Huawei Cloud will not store the code recommendations you accepted or any code written by yourself permanently.
1.7 You are responsible for your end users. If your end users violate laws and regulations when using services related to this Agreement, or misuse related services and cause damages to third parties or Huawei Cloud, you shall be liable for compensation.
1.8 Our Limited Warranty
- 1.8.1 Huawei Cloud promises to continuously improve service quality, but cannot guarantee that this service is free of interruption and defects.
- 1.8.2 You understand and agree to our limited warranty in the service level agreement (SLA) described in Clause 4.3 "Our Limited Warranty" https://www.huaweicloud.com/declaration/sa_cua_computing.html of the Huawei Cloud Customer Agreement.
- 1.8.3 The provision of a Huawei Cloud service is subject to availability and service features at the time of provisioning, and does not constitute a commitment of Huawei Cloud to provide the cloud service beyond its lifecycle. Huawei Cloud will make the best commercial efforts to notify you of changes to service SLAs.
- 1.8.4 Notwithstanding Clauses 1.8.2 and 1.8.3, the commitment of service availability in Clause 2.6 of this Statement shall apply exclusively to this Service during the OBT.
1.9 Statement by Both Parties
- 1.9.1 You understand and agree that your use of this Service must comply with applicable laws and regulations. We only provide a standard service upon your request and are not responsible for the legal compliance of your use of this Service. If we reasonably believe that you have violated laws, regulations, or the rights of third parties when using this Service, or violated the terms of related agreements (including Legal Statement, Privacy Statement, Acceptable Use Policy, Huawei Cloud Customer Agreement, and other agreements related to you on the Huawei Cloud official website) ("Prohibited Content"), we reserve the right to delete prohibited content, prohibit your use of related services and access to related content, or suspend services. In addition, you shall compensate all losses caused to Huawei Cloud due to your actions.
- 1.9.2 Huawei Cloud provides O&M only for Huawei Cloud services. You shall ensure the security and stability of your own network and devices. If any device fault or network interruption occurs due to your own or third-parties' reasons, you shall resolve the issue in a timely manner to avoid impacting Huawei Cloud services.
1.10 Disclaimer
- 1.10.1 You understand and agree that we are not liable for unavailability of related services in the following situations:
- Conditions listed in Clause 4.4 "Disclaimer" and Clause 9.2 "Suspension" of Huawei Cloud Customer Agreement https://www.huaweicloud.com/declaration/sa_cua_computing.html
- Service unavailability or any legal consequences caused by your refusal to provide relevant or sufficient information
- Service unavailability due to force majeure
- Service unavailability during regular service maintenance
2. Huawei Cloud CodeArts Doer for Coding Terms of Service
2.1 Service Content
- Huawei Cloud CodeArts Doer for Coding is an integrated development environment (IDE) plug-in for intelligent code generation
2.2 Personal Information in Your Code
- To protect the legitimate rights and interests of you and your end users (if any), you are not advised to upload and retain code with personal data through this Service. You understand and agree that you and/or your end users have obtained the consent and authorization from related data subjects for use of the personal data in the code uploaded and retained during the use of this Service. Huawei Cloud is entrusted to process the personal data for the purpose of providing this Service.
2.3 Cooperation You Need to Provide
- CodeArts Doer for Coding is an IDE plug-in. To use this Service, you need to first install the specified IDE. If data leakage occurs because of unauthorized OS or IDE, or infection by Trojans, you understand and agree to bear the consequences and ensure that Huawei Cloud will not suffer any loss.
2.4 Restrictions
You shall not use CodeArts Doer for Coding for any of the following purposes: (1) Develop applications that violate laws. (2) Develop applications related to the following businesses. In the event of any of the above, we reserve the right to unilaterally suspend or terminate the provisioning this Service to you and ask you to compensate us for any and all losses arising therefrom. In addition, we reserve the right to withhold any cloud service fees or support service fees you have already paid. If you use this Service to create groups or run businesses in specific industries (such as education, healthcare, and banking), you must comply with the data protection laws and regulations of the relevant countries and regions.
Prohibited businesses include but are not limited to:
- Finance: loan, usury, loan and debt collection, precious metal transaction (such as paper gold), stock software or stock recommendation, futures, financial insurance, and Internet finance
- Outbound marketing: pharmaceutical sales, retail sales, new house sales, renovations, real estate agency, and sales followups
- Education: international education, education sales, and education return visit
- Call center: outbound calling, cold-calling, and robot calling
- Other businesses: invoicing and accounting agency, personal phone service, intellectual property rights agency, carrier service, POS machine sales, games, QR code scanning for car moving, cigarettes, wines, teas, registration, auctions, collections, positive feedback, medical aesthetics, social networking, and other activities that violate laws, regulations, policies, and carrier requirements, or Huawei Cloud considers improper.
2.5 Disclaimers
- 2.5.1 You shall understand and agree that the code presented to you by this Service is only sample code. During your use of this Service, Huawei Cloud and this Service do not actually generate or write any code. If you choose to use the code recommended by this Service, you shall be deemed to have written the code. You shall be the sole copyright owner of the generated and selected code, and shall assume corresponding responsibilities for your work.
- 2.5.2 This Service is provided without warranty of any kind. Huawei Cloud and this Service are not responsible for the security, defects, quality, and compatibility of any code recommended during your use of this Service. You shall be responsible for the security and quality of the code you generated, regardless if the code is written fully by yourself or based on the recommendations of this Service. When using code recommended by this Service, you are advised to take precautions adopted during self-coding that include rigorous testing, IP scanning, and security vulnerability tracking.
2.6 Other Special Notes
- CodeArts Doer for Coding is currently available in OBT. During the OBT, Huawei Cloud provides this Service free of charge without any SLA commitments for this Service.
