AutoDoc ChatGPT

Autodoc-chatgpt

Autodoc-chatgpt ist ein Python-Skript, das die Leistung des ChatGPT-Modells nutzt, um automatisch Dokumentation für jede Programmiersprache zu generieren.

Mit autodoc-chatgpt können Sie problemlos umfassende Dokumentation für Ihre Codebasis erstellen. Geben Sie einfach den Pfad zur Datei an, die Sie dokumentieren möchten, und autodoc-chatgpt generiert eine detaillierte Beschreibung seiner Funktionalität, Parameter und Rückgabewerte in der natürlichen Sprache.

Erste Schritte

Installation

Klonen Sie dieses Repository in Ihre lokale Maschine:

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

Installieren Sie dann die erforderlichen Pakete:

pip install -r requirements.txt

Unterstützte Programmiersprachen

• Python
• JavaScript
• Typoskript
• Gehen
• C#
• C ++
• Php
• Rubin
• Rost
• Java
• Kotlin

Und andere ...

disclaimer : TypeScript und Javscript haben einige Fehler und werden untersucht

disclaimer_2.0 : Es gibt einen bekannten Fehler, der Dateien mit 2 oder mehr Klassen mit Methoden mit demselben Namen kommentiert.

Verwendung

Konfiguration bearbeiten

Öffnen Sie config.ini und fügen Sie dort email und password hinzu, wenn Sie die OAuth -Autorisierung nicht verwenden. Ansonsten öffnen Sie Chatgpt und erhalten Sie den __Secure-next-auth.session-token Cookie und schreiben Sie es in die session-token .

Start

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

Der Pfad zur Datei kann entweder relativ oder absolut sein.

Nach der Ausführung wird die Datei yourfilename_commented.language im Ordner mit der gewünschten Datei erstellt.

ODER

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

Nicht empfohlen, wenig getestet. Sie können eine Datei mit einer Kommentaroption angeben, um solche Kommentare zu erstellen.

Nutzungsbeispiel

Alternative Verwendung

Sie können dies auch als Funktion in Python verwenden.

 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 

Haftungsausschluss

Erstellt nicht immer korrekte Kommentare. Es bedeutet nicht immer, was Sie wollen. Verwenden Sie als Entwurf der Kommentare, die möglicherweise bearbeitet werden müssen.

Lizenz

Dieses Projekt ist unter der MIT -Lizenz lizenziert.

Anerkennung

Vielen Dank an die Entwicklung von KI und separat an сhatgpt für die Erzeugung des Readme.

Und auch Acheong08 zum Erstellen von Chatgpt.