AutoDoc ChatGPT

Autodoc-chatgpt

Autodoc-chatgpt é um script python que aproveita o poder do modelo ChatGPT para gerar automaticamente a documentação para qualquer linguagem de programação.

Com o Autodoc-ChATGPT, você pode gerar facilmente documentação abrangente para sua base de código. Simplesmente forneça o caminho para o arquivo que você deseja documentar, e o Autodoc-ChATGPT gerará uma descrição detalhada de sua funcionalidade, parâmetros e valores retornará na linguagem natural.

Começando

Instalação

Clone este repositório para sua máquina local:

git clone https://github.com/awekrx/AutoDoc-ChatGPT.git

Em seguida, instale os pacotes necessários:

pip install -r requirements.txt

Linguagens de programação suportadas

• Python
• JavaScript
• TypeScript
• Ir
• C#
• C ++
• Php
• Rubi
• Ferrugem
• Java
• Kotlin

E outros ...

disclaimer : TypeScript e Javscript tem alguns bugs e estão em teste

disclaimer_2.0 : Há um erro conhecido comentar arquivos com 2 ou mais classes que possuem métodos com o mesmo nome.

Uso

Editar configuração

Open config.ini e adicione email e password lá se você não estiver usando a autorização do OAuth. Caso contrário, abra o chatgpt e obtenha o biscoito __Secure-next-auth.session-token e escreva-o para o session-token .

Começar

py main.py -file " path to the file "

O caminho para o arquivo pode ser relativo ou absoluto.

Após a execução, o arquivo yourfilename_commented.language é criado na pasta com o arquivo desejado.

OU

py main.py -file " path to the file "

Não recomendado, pouco testado. Você pode especificar um arquivo com uma opção de comentário para criar esses comentários.

Exemplo de uso

Uso alternativo

Você também pode usar isso como uma função no Python.

 from modules . autodoc import AutoDoc
import configparser

config = configparser . ConfigParser ()
config . read ( "config.ini" )

auth = {
    "email" : config [ "ChatGPT" ][ "email" ],
    "password" : config [ "ChatGPT" ][ "password" ],
    "session_token" : config [ "ChatGPT" ][ "session_token" ]
}

result = AutoDoc (
        auth ,
        "Code for commenting" ,
        "language code" ,
        "example comment model (optional)"
    ). start ()
print ( result )
# out: Code with comments 

Isenção de responsabilidade

Nem sempre cria comentários corretos. Nem sempre significa o que você quer. Use como um rascunho de comentários que podem precisar ser editado.

Licença

Este projeto está licenciado sob a licença do MIT.

Agradecimentos

Muito obrigado ao desenvolvimento da IA ​​e separadamente para obter o valor de gerar o ReadMe.

E também acheong08 para criar chatgpt.