Pular para o conteúdo principal

Criar Quick Command de Code Review .NET

Aprenda a criar um Quick Command na StackSpot AI para realizar uma análise de código .NET, identificando oportunidades de refatoração e verificando se o código segue as boas práticas de taxonomia e segurança.

Passos para criar um Quick Command

Passo 1. Acesse o Portal da StackSpot AI

Passo 2. Criar um novo Quick Command

  1. Clique na seção ‘Quick Command’;
  2. Clique no botão ‘IDE’;
  3. Preencha as seguintes informações: Nome do Quick Command, Comando de execução, e a Descrição. Exemplo: dotnet-review.
  4. Clique no botão ‘Próximo’.
  5. Escolha a opção em branco e clique no botão ‘Criar’.

Passo 3. Configurar o prompt de análise de refatoração

  • Selecione a opção Prompt.
  • Preencha os campos:
    • Nome do Prompt: analyze-refactoring
    • Prompt:
Papel: Engenheiro de software especialista em C#
Tarefa: Analisar o código selecionado e identificar oportunidades de refactoring.
Código fonte: {{selected_code}} 
Saída esperada: Uma lista de sugestões de refactoring, incluindo a justificativa para cada uma.
Observações: As sugestões devem seguir as boas práticas de desenvolvimento .NET, como SOLID.
  • Clique em ‘OK’

Passo 4. Adicionar prompt de análise de boas práticas

  • Clique na e arraste a caixa de ‘Prompt’ e preencha os campos:
    • Nome do Prompt: analyze-best-practices
    • Prompt:
Papel: Engenheiro de software especialista em C#
Tarefa: Analisar o código selecionado e verificar se ele segue as boas práticas de taxonomia e segurança.
Código fonte: {{selected_code}} 
Saída esperada: Um relatório detalhado sobre as boas práticas seguidas e as que precisam ser melhoradas, com foco em taxonomia e segurança.
Observações: O relatório deve incluir recomendações para melhorar a segurança e a organização do código.
  • Conecte as caixas uma à outra até chegar ao final.

Passo 5. Finalizar o Quick Command

  • Clique em ‘Finalizar’ para terminar a criação do Quick Command.
  • Na seção de Utilização do Quick Command, escolha a opção Interface para que o comando seja executado via chat da extensão.

Passo 6. Configurar o Resultado Final

No campo de Resultado Final, insira o seguinte código para exibir as respostas dos dois prompts:

# analyze-refactoring
`{{analyze-refactoring.answer}}`
# analyze-best-practices
`{{analyze-best-practices.answer}}`

Passo 7. Testar o Quick Command

  • Acesse sua IDE com a extensão da StackSpot AI instalada.
  • Selecione o código .NET que deseja revisar, por exemplo:
public class OrderService
{
    public void ProcessOrder(Order order)
    {
        if (order == null)
        {
            throw new ArgumentNullException(nameof(order));
        }

        if (order.Items.Count == 0)
        {
            throw new InvalidOperationException("Order must have at least one item.");
        }

        // Process the order
        foreach (var item in order.Items)
        {
            // Process each item
        }
    }
}

  • Clique com o botão direito no código selecionado e escolha ‘StackSpot AI > Meus Quick Commands > dotnet-review‘.

Passo 8. Revisar o resultado

  • O Quick Command irá analisar o código, identificando oportunidades de refatoração e verificando se ele segue as boas práticas de taxonomia e segurança.
  • O resultado será exibido no chat, com as sugestões de refatoração e o relatório de boas práticas.