Suporte a idiomas e padrões

A tabela a seguir lista as linguagens de código e o padrão de documentação correspondente para cada linguagem de código.

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 gerar documentação

Você pode usar o comando ' /document no chat para gerar documentação para um arquivo referenciado, um método ou uma classe no espaço de trabalho ativo.

Use esta sintaxe:

/document <code reference> [additional instructions]

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

• Para " <code reference>, digite o símbolo " @ para ver uma lista de arquivos, classes e métodos de seu espaço de trabalho. Use um arquivo, método ou referência de classe de cada 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.

Usando o CodeLens no editor para gerar documentação

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

1. Clique na opção Documento que precede imediatamente um bloco de código ou snippet para gerar sua documentação.

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

   

2. A janela de bate-papo watsonx Code Assistant é aberta, exibe o comando ' /document @<*item name*>, executa o comando e exibe o código com a documentação adicionada como comentários.