Explicação do código

watsonx Code Assistant

Use IA generativa para analisar e resumir seu código para entender o que ele faz.

A tabela a seguir lista o tipo de explicação para cada plano.

Tipos de explicação
Plano Explicação Descrição
Plano de teste Plano essencial Básico Usa IA generativa para fornecer uma explicação básica. Não é necessária nenhuma análise de código adicional.
Plano Standard Aprimorados Requer um aplicativo criado e usa uma análise de código e IA generativa para fornecer uma explicação de código aprimorada para métodos/classes Java e aplicativos Java corporativos.

Somente no Eclipse IDE: Para obter melhores resultados com um aplicativo Java multimódulo, certifique-se de importar o módulo agregador e cada submódulo como projetos separados no espaço de trabalho Eclipse. é improvável que Watsonx Code Assistant introspeccione seu projeto com sucesso se você importar o diretório de nível superior como um único projeto.

Suporte ao idioma

A explicação do código está disponível para os seguintes idiomas:

  • C
  • C++
  • Acessar
  • Java
  • JavaScript
  • Python
  • TypeScript

Quando você faz referência a um método ou usa CodeLens em um método, watsonx Code Assistant oferece suporte a determinadas linguagens de código. A referência a um arquivo completo funciona em todos os idiomas. Para obter mais informações, consulte Suporte ao idioma quando você trabalha com métodos.

Uso de um comando de bate-papo para explicar o código

Você pode usar o comando ' /explain no bate-papo para explicar o código de uma classe, arquivo, função ou método referenciado no espaço de trabalho ativo.

Use esta sintaxe:

/explain <code reference> [additional instructions]

  • Certifique-se de iniciar o prompt com /explain, seguido do restante da sintaxe.

  • Para " <code reference>, digite o símbolo " @ para ver uma lista de classes, arquivos, funções e métodos do seu espaço de trabalho. Use uma referência de classe, arquivo, função ou método por vez.

  • O " [additional instructions] é opcional. Adicione instruções se você quiser detalhes específicos.

Quando você faz referência a um arquivo, o limite de tamanho é de 50 KB. Se você atingir esse limite, divida o arquivo em funções individuais e faça referência a cada função. Ou, divida o arquivo em 49 KB, cuidando dos limites da função, e faça referência ao arquivo em cada divisão. Em qualquer uma das abordagens, você precisa mesclar os resultados.

Usar o CodeLens no editor para explicar o código

No editor do IDE, o CodeLens mostra uma linha de opções de IA generativa que precede os blocos e trechos de código.

Problema conhecido Se você estiver usando a extensão watsonx Code Assistant for Enterprise Java Applications, na inicialização poderá levar alguns segundos para que os recursos aprimorados do Java estejam disponíveis no CodeLens.

  1. Clique na opção Explain (Explicar ) que precede imediatamente um bloco de código para gerar uma explicação.

    No exemplo de código a seguir, as opções ' Explain | Document | Unit Test precedem imediatamente as palavras-chave ' protected void.

    Exemplo de CodeLens
    Exemplo deCodeLens

  2. A janela de bate-papo watsonx Code Assistant é aberta, exibe o comando ' /explain @<*item name*>, executa o comando e exibe a explicação.

Desativação CodeLens

Se quiser desativar as opções do CodeLens, você pode alterar a configuração da extensão ou do plug-in.

Em Visual Studio Code:

  1. Abra as configurações da extensão.

  2. Limpe a configuração Enable CodeLens.

Em Eclipse:

  1. Abra as configurações do site Eclipse IDE.

  2. Na entrada watsonx Code Assistant Settings, desmarque a configuração Enable CodeLens.

  3. Clique em Aplicar e fechar.

Usando o explorador para explicar o código

Para gerar uma explicação a partir do Explorer ( Visual Studio Code ) ou do Project Explorer ( Eclipse ):

  1. Expanda seu aplicativo para o código para o qual você deseja gerar uma explicação.

  2. Clique com o botão direito do mouse no código, clique em watsonx Code Assistant e, em seguida, clique em Explain.

  3. O chat watsonx Code Assistant exibe o comando ' /explain para o código que você selecionou. A sintaxe a seguir é usada no comando:

    /explain <code syntax>

  4. Watsonx Code Assistant processa a solicitação e, no bate-papo, exibe a explicação do código que você selecionou.

Explicação dos aplicativos Java

Plano padrão A explicação do aplicativo só está disponível com a extensão watsonx Code Assistant for Enterprise Java Applications.

A explicação do aplicativo é compatível apenas com aplicativos Java que contêm uma ou mais classes que estendem ' javax.servlet.http.HttpServlet. Essas classes precisam implementar qualquer um dos seguintes métodos: ' doGet, ' doPost, ou ' doPut.

Para aplicativos grandes, a explicação considera os 40 pontos de entrada com a maior complexidade ciclomática. Se a solicitação exceder 40 pontos de entrada, a explicação contém a seção The following methods were not considered: que fornece detalhes sobre quais pontos de entrada não foram considerados.

Para solicitar e visualizar uma explicação para um aplicativo:

  1. No IDE, clique com o botão direito do mouse em qualquer item da hierarquia no diretório do aplicativo que você deseja explicar e clique em Explicar aplicativo.

    No Eclipse IDE, se você tiver um aplicativo multimódulo com uma raiz de multimódulo par, a explicação do aplicativo se aplica somente ao módulo selecionado.

  2. Watsonx Code Assistant examina o aplicativo para gerar uma visão geral e uma lista dos principais serviços com uma descrição das funções de cada método.

  3. Clique em Salvar para manter uma cópia ou a explicação será descartada.

  4. Clique em Abrir explicação e revisar e, em seguida, clique em Salvar explicação do aplicativo para armazenar em um arquivo local.