AutoDoc ChatGPT

Autodoc-chatgpt

AutoDoc-ChatGPT es un script de Python que aprovecha la potencia del modelo CHATGPT para generar automáticamente documentación para cualquier lenguaje de programación.

Con AutoDoc-ChatPPT, puede generar fácilmente una documentación integral para su base de código. Simplemente proporcione la ruta al archivo que desea documentar, y Autodoc-ChatPPT generará una descripción detallada de su funcionalidad, parámetros y valores de retorno en lenguaje natural.

Empezando

Instalación

Clone este repositorio a su máquina local:

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

Luego instale los paquetes requeridos:

pip install -r requirements.txt

Lenguajes de programación compatibles

• Pitón
• Javascript
• Mecanografiado
• Ir
• DO#
• C ++
• Php
• Rubí
• Óxido
• Java
• Kotlín

Y otros ...

disclaimer : TypeScript y Javscript tienen algunos errores y están en prueba

disclaimer_2.0 : hay un error conocido comentando archivos con 2 o más clases que tienen métodos con el mismo nombre.

Uso

Editar configurar

Abra config.ini y agregue email y password allí si no está utilizando la autorización de OAuth. De lo contrario, abra el chatgpt y obtenga la cookie __Secure-next-auth.session-token y escríbela en la session-token .

Comenzar

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

La ruta al archivo puede ser relativa o absoluta.

Después de la ejecución, el archivo yourfilename_commented.language se crea en la carpeta con el archivo deseado.

O

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

No recomendado, pequeño probado. Puede especificar un archivo con una opción de comentarios para crear dichos comentarios.

Ejemplo de uso

Uso alternativo

También puede usar esto como una función en 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 

Descargo de responsabilidad

No siempre crea comentarios correctos. No siempre significa lo que quieres. Use como un borrador de comentarios que pueden necesitar ser editados.

Licencia

Este proyecto tiene licencia bajo la licencia MIT.

Expresiones de gratitud

Muchas gracias al desarrollo de la IA y por separado a сhatgpt por generar el ReadMe.

Y también achang08 para crear chatgpt.