Qoder CN Series:Geração de código empresarial

O Qoder CN oferece um recurso de geração aumentada por recuperação para a geração de código inline. Ao utilizar essa funcionalidade, o Qoder CN usa o repositório de código da sua empresa como contexto para o preenchimento automático. Isso garante que o código gerado esteja mais alinhado aos padrões de codificação e às características de negócio da sua organização.

import React from 'react'
type Props = {
  children:react.reactnode;
}
// bad
const lndex = (props: Props)=> {
  return <>{props.children}</>
}
// bad
const Index<Props>=({ children }) => {
  return <>{children}</>
}
// good
const Index: React.FC<Props> = (props) => {
  return <>{props.children}</>
}

Qoder CN administradores e administradores globais no nível da organização (para Enterprise Dedicated Edition) podem adicionar ou remover arquivos de código e ativar ou desativar o recurso de geração aumentada por recuperação na página Knowledge management do Qoder CN console.

Gerenciamento da base de conhecimento empresarial

Administradores do Qoder CN e administradores globais no nível da organização (para Enterprise Dedicated Edition) têm permissão para gerenciar bases de conhecimento empresariais. Esse gerenciamento inclui criar, editar e excluir bases de conhecimento, controlar a visibilidade dos membros e adicionar ou remover arquivos de código de uma base de conhecimento.

Criar, editar e excluir uma base de conhecimento

Criar uma base de conhecimento

1. Na barra lateral, clique em Knowledge management.

2. Na página Knowledge management, clique em New knowledge base.

3. Na caixa de diálogo, configure os seguintes parâmetros:

   • Defina Application scenario como inline code generation.

   • Insira um Knowledge base name claro e fácil de identificar.

   • (Opcional) Preencha o campo Description com um resumo do conteúdo ou da finalidade da base de conhecimento.

   • Selecione a Visibility. A opção padrão, Private, restringe a visibilidade da base de conhecimento apenas aos seus membros.

4. Após configurar os parâmetros, clique em OK.

5. Depois da criação, a nova base de conhecimento aparecerá na lista da página Knowledge management.

Editar uma base de conhecimento

É possível modificar o nome, a descrição e a visibilidade de uma base de conhecimento das seguintes formas:

1. Pela página Knowledge management: localize a base de conhecimento desejada na lista e clique no ícone de edição.

2. Pela página de detalhes da base de conhecimento: navegue até a página de detalhes da base de conhecimento que deseja modificar e clique no ícone de edição.

Excluir uma base de conhecimento

Para excluir uma base de conhecimento, acesse a página de detalhes dela e clique no botão de exclusão. Será necessário inserir o nome da base de conhecimento para confirmar a operação.

Carregar um arquivo de código

Administradores do Qoder CN e administradores globais no nível da organização (para Enterprise Dedicated Edition) podem gerenciar os dados dentro de uma base de conhecimento. Siga as etapas abaixo para carregar dados:

1. Clique em Add data.

2. Com o tipo de dado definido como Code, clique ou arraste um arquivo de código para a área de upload (a área cinza).

   Ao carregar um arquivo, observe os seguintes requisitos:

   • Carregue apenas um arquivo de repositório de código por vez.

   • Formatos de arquivo suportados: zip, gz e tar.gz.

   • O tamanho do arquivo não pode exceder 100 MB.

   • O nome do arquivo deve ter no máximo 200 caracteres, e apenas as codificações UTF-8 e GBK são suportadas.

   • Recomendamos o uso de um repositório de código hierárquico e estruturado para evitar perda de informações durante a recuperação.

3. Após concluir o upload, clique em Confirm add. O sistema iniciará o processamento do arquivo de código.

Ativar ou desativar a geração aumentada por recuperação

Quando o sistema terminar de processar o arquivo de código, você poderá ativar ou desativar a geração aumentada por recuperação para código inline de duas maneiras:

1. Na página Knowledge management: encontre a base de conhecimento alvo na lista e alterne o switch de geração aumentada por recuperação.

2. Na página de detalhes da base de conhecimento: acesse a página de detalhes da base de conhecimento desejada e alterne o switch de geração aumentada por recuperação.

O switch Enable retrieval-augmented generation fica localizado no canto superior direito da página de detalhes da base de conhecimento.

Com esse recurso ativado, quando desenvolvedores autorizados usarem o recurso de geração inteligente de código inline do Qoder CN no cliente da IDE, as sugestões de código serão geradas com base nos dados de código carregados.

Caso de uso

Geralmente, equipes de front-end mantêm padrões de codificação unificados. Por exemplo, ao desenvolver com ReactJS, a equipe costuma definir práticas recomendadas e não recomendadas claras para escrever props, visando melhorar a clareza e a eficiência do código, além de evitar maus hábitos de programação.

Nesse cenário, é possível aprimorar a geração utilizando o repositório de código do Qoder CN. Veja como proceder:

1. Um administrador do Qoder CN carrega no console um arquivo de código que segue os padrões de codificação da empresa. Por exemplo, você pode carregar o repositório Ant Design, que adota padrões rigorosos de design de componentes React.

2. Ative a geração aumentada por recuperação para código inline.

3. Os engenheiros de front-end da equipe instalam e ativam o Qoder CN em suas IDEs.

4. Durante a escrita de código por um engenheiro de front-end, o Qoder CN fornece sugestões de código que respeitam os padrões de codificação do repositório carregado.

import React from 'react';
interface IProps {}
const Index: React.FC<IProps> = () => {
    return <div>Index</div>;
};

Gerenciar a visibilidade da base de conhecimento

Administradores do Qoder CN e administradores globais no nível da organização (para Enterprise Dedicated Edition) podem alterar a visibilidade de uma base de conhecimento empresarial de duas formas:

1. Modifique a configuração de visibilidade ao editar a base de conhecimento.

2. Acesse a base de conhecimento, clique na aba Visible Members e adicione ou remova membros.

Visualizar o status do processamento de dados

Após o upload de um arquivo de código, o sistema realiza a vetorização dos dados. Esse processo converte o código em um formato que possibilita a geração aumentada por recuperação. Você pode acompanhar o status do processamento de dados na lista de repositórios de código. Os possíveis status incluem:

• Waiting for processing: o sistema processa os arquivos carregados em ordem. Arquivos que ainda não começaram a ser processados ficam na fila.

• Processing: o arquivo está sendo analisado e vetorizado.

• Completed: a análise do arquivo foi concluída e a vetorização terminou com sucesso.

• Abnormal: ocorreu um erro durante o processamento. Passe o mouse sobre o indicador de status para ver a causa do erro. Com base nessa informação, decida se deseja reprocessar ou excluir o arquivo.

• Duplicate file: o conteúdo do arquivo é idêntico ao de um arquivo já processado. O sistema ignora arquivos duplicados. Você pode excluir este arquivo.

Atualizar um repositório de código

Caso seu repositório de código seja atualizado, carregue a nova versão como um novo arquivo. O sistema processará o novo arquivo logo após o upload.

Excluir um repositório de código

Para excluir repositórios de código individuais que estejam anômalos, duplicados ou desnecessários, clique no ícone de exclusão correspondente a cada repositório. Se preferir excluir repositórios em lote, marque as caixas de seleção dos repositórios desejados na lista e clique no botão de exclusão.