O DocMeAI é um facilitador que permite, de forma rápida e prática, documentar métodos dentro das suas units no Delphi utilizando Inteligência Artificial. A ferramenta gera automaticamente os XML Documentation Comments para seus métodos, simplificando a documentação de código e aumentando a produtividade.
Agora, com o novo recurso Diff Comment, o DocMeAI também gera automaticamente um resumo das alterações realizadas em um projeto versionado com Git. Essa funcionalidade ajuda a entender rapidamente as mudanças feitas no código, facilitando revisões e commits mais claros.
Para utilizar o DocMeAI, você precisará ter instalado o DelphiOpenAI. Siga as etapas abaixo para instalar e configurar o projeto:
-
Baixar o DelphiOpenAI
- Acesse o repositório oficial do DelphiOpenAI: https://github.com/HemulGM/DelphiOpenAI.
- Baixe o repositório ou clone para sua máquina.
-
Build e Instalação
- Abra o projeto do DelphiOpenAI no Delphi.
- Compile e instale o pacote para que os componentes do DelphiOpenAI fiquem disponíveis na sua IDE.
-
Configuração do DocMeAI
- Abra o DocMeAI no Delphi.
- Builde e instale o pacote.
-
Acesse o menu "Configurations" no DocMeAI.
-
Informe os seguintes dados obrigatórios para configurar o acesso aos serviços de IA do ChatGPT:
-
Para o Diff Comment, acesse a aba Git e efetue as configurações dos campos.
-
Clique em Salvar para concluir a configuração.
- Selecione os métodos que deseja documentar em sua unit.
- Use o atalho
CTRL + SHIFT + Dou clique no menu "Documentation". - (Opcional) Insira instruções adicionais antes de gerar a documentação, caso queira orientar a IA para casos específicos.
- Clique em "Document".

- O código selecionado será automaticamente documentado com os XML Documentation Comments do Delphi.
- Utilize o recurso Diff Comment para gerar um resumo automático das alterações realizadas em seu projeto versionado com Git.
- O recurso analisa:
- Arquivos modificados: Detecta automaticamente as mudanças em arquivos rastreados.
- Arquivos staged: Inclui arquivos preparados para commit usando o comando
git add. - Novos arquivos: Lembre-se de usar
git addpara que arquivos novos sejam incluídos no resumo.
- Acesse o menu "Diff Comment" e clique em "Generate Diff" para criar o resumo.
- O DocMeAI irá gerar um resumo das alterações agrupadas por arquivo, destacando as principais modificações funcionais e estruturais.

Nota: Apenas arquivos modificados ou staged serão analisados. Para novos arquivos, certifique-se de adicioná-los com git add.
function CalculateTotal(const pValue1, pValue2: Double): Double;
begin
Result := pValue1 + pValue2;
end;
