Este tópico descreve casos de uso comuns para comandos de extensão personalizados, como verificação de estilo de código, convenção de nomenclatura de variáveis e geração de referência de API. Esse recurso expande as capacidades de personalização para empresas e simplifica a forma como seus desenvolvedores utilizam o AI Chat.
O novo site de documentação do Qoder CN já está disponível. O conteúdo deste site pode não refletir os recursos e alterações mais recentes do product. Acesse docs.qoder.cn para obter a documentação mais recente do product.
Para saber como criar e usar um comando de extensão personalizado, consulte Gerencie extensions.
Cenários de exemplo
Cenário 1: Verificações de estilo de código
Caso de uso
Tradicionalmente, a varredura de código em busca de problemas ocorre após o envio, um processo lento e custoso. É possível antecipar essa verificação fornecendo ao modelo de IA o contexto técnico e de negócios, juntamente com padrões de codificação personalizados. Isso permite que o modelo analise seu código e forneça feedback imediato. O exemplo a seguir mostra uma verificação de estilo de código Java para uma aplicação de serviços financeiros.
Configuração do comando
|
Command name |
code style check |
|
Command name (English) |
my code scan |
|
Icon |
Any icon |
|
Description |
Performs a code style check and outputs the results. |
|
Access control |
Selecione an option based on your requirements. |
|
Prompt |
|
|
Context configuration |
There are five available context variables: Check the following code in |
Cenário 2: Geração de referência de API
Caso de uso
Em sistemas distribuídos e arquiteturas orientadas a service (SOA), o desenvolvimento é impulsionado por API. Após desenvolver uma API, é necessário fornecer uma referência de API para ajudar os consumidores a integrar e depurar rapidamente suas implementações.
Configuração do comando
|
Command name |
API reference generation |
|
Command name (English) |
generate api docs |
|
Icon |
Any icon |
|
Description |
Generates an API reference for a newly developed API. |
|
Access control |
Selecione an option based on your requirements. |
|
Prompt |
|
|
Context configuration |
There are five available context variables: Generate an API reference for the following code in |
Cenário 3: Convenções de nomenclatura de variáveis
Caso de uso
Durante o desenvolvimento, nomear variáveis é uma tarefa constante. Um nome de variável descritivo, legível e em conformidade é marca registrada de um desenvolvedor profissional e de código de alta qualidade. Boas convenções de nomenclatura melhoram a manutenibilidade do código, aumentam a legibilidade e promovem uma colaboração eficaz da equipe.
Configuração do comando
|
Command name |
variable naming convention |
|
Command name (English) |
variable naming assistant |
|
Icon |
Any icon |
|
Description |
Generates suitable variable names based on a user's description that adhere to company and team coding standards. |
|
Access control |
Selecione an option based on your requirements. |
|
Prompt |
|
|
Context configuration |
Selecione the userInput variable. Leave the other variables (selectedCode, file, gitCommit, and codeChanges) unselected. Defina all context variables as optional. Usage: Execute the custom command |
Como funciona
Ao acionar um comando de extensão personalizada digitando / seguido do nome do comando, o seguinte processo ocorre:
O contexto configurado para o comando, como um trecho de código selecionado ou entrada do usuário, é capturado. Em seguida, o prompt e o modelo do comando são aplicados.
O prompt instrui o modelo a analisar o contexto, gerando resultados como sugestões de estilo de código, referências de API ou recomendações de nomes de variáveis. Esses resultados são então retornados para você.