تنزيل AutoDoc ChatGPT - تنزيل رمز المصدر AutoDoc ChatGPT

AutoDoc ChatGPT

شفرة المصدر الأخرى

Autodoc-ChatGPT 1.0

تنزيل

Autodoc-Chatgpt

Autodoc-Chatgpt هو نص Python الذي يعزز طراز ChatGPT لإنشاء وثائق تلقائيًا لأي لغة برمجة.

باستخدام Autodoc-Chatgpt ، يمكنك بسهولة إنشاء وثائق شاملة لقاعدة الكود الخاصة بك. ما عليك سوى توفير مسار الملف الذي ترغب في توثيقه ، وسيقوم AutoDoc-Chatgpt بإنشاء وصف مفصل لوظائفه ومعلماته وقيمه باللغة الطبيعية.

ابدء

التثبيت

استنساخ هذا المستودع إلى جهازك المحلي:

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

ثم قم بتثبيت الحزم المطلوبة:

pip install -r requirements.txt

لغات البرمجة المدعومة

وآخرون ...

disclaimer : يحتوي TypeScript و Javscript على بعض الأخطاء ويخضعون للاختبار
disclaimer_2.0 : هناك خطأ معروف يعلق على ملفات مع فئتين أو أكثر لهما أساليب تحمل نفس الاسم.

الاستخدام

تحرير التكوين

افتح config.ini وأضف email وكلمة password هناك إذا كنت لا تستخدم تفويض OAuth. خلاف ذلك ، افتح chatgpt واحصل على ملف تعريف ارتباط __Secure-next-auth.session-token واكتبه إلى session-token .

يبدأ

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

يمكن أن يكون المسار إلى الملف نسبيًا أو مطلقًا.

بعد التنفيذ ، يتم إنشاء ملف yourfilename_commented.language في المجلد مع الملف المطلوب.

أو

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

غير موصى به ، تم اختباره القليل. يمكنك تحديد ملف مع خيار تعليق لإنشاء مثل هذه التعليقات.

مثال الاستخدام

معاينة الاستخدام

استخدام بديل

يمكنك أيضًا استخدام هذا كدالة في بيثون.

 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