Autodoc-Chatgpt เป็นสคริปต์ Python ที่ใช้ประโยชน์จากพลังของโมเดล chatgpt เพื่อสร้างเอกสารโดยอัตโนมัติสำหรับภาษาการเขียนโปรแกรมใด ๆ
ด้วย Autodoc-Chatgpt คุณสามารถสร้างเอกสารที่ครอบคลุมสำหรับ codebase ของคุณได้อย่างง่ายดาย เพียงจัดเตรียมพา ธ ไปยังไฟล์ที่คุณต้องการจัดทำเอกสารและ Autodoc-Chatgpt จะสร้างคำอธิบายโดยละเอียดเกี่ยวกับฟังก์ชันการทำงานพารามิเตอร์และค่าส่งคืนในภาษาธรรมชาติ
โคลนที่เก็บนี้ไปยังเครื่องในพื้นที่ของคุณ:
git clone https://github.com/awekrx/AutoDoc-ChatGPT.git
จากนั้นติดตั้งแพ็คเกจที่ต้องการ:
pip install -r requirements.txt
และคนอื่น ๆ ...
disclaimer
: TypeScript และ Javscript มีข้อบกพร่องบางอย่างและอยู่ระหว่างการทดสอบ
disclaimer_2.0
: มีข้อผิดพลาดที่รู้จักกันดีว่ามีไฟล์แสดงความคิดเห็นที่มีคลาส 2 ชั้นขึ้นไปที่มีวิธีการที่มีชื่อเดียวกัน
เปิด 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 "
ไม่แนะนำให้ทดสอบเล็กน้อย คุณสามารถระบุไฟล์ที่มีตัวเลือกความคิดเห็นเพื่อสร้างความคิดเห็นดังกล่าว
คุณยังสามารถใช้สิ่งนี้เป็นฟังก์ชั่นใน 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
ไม่ได้สร้างความคิดเห็นที่ถูกต้องเสมอไป มันไม่ได้หมายถึงสิ่งที่คุณต้องการเสมอไป ใช้เป็นร่างของความคิดเห็นที่อาจต้องแก้ไข
โครงการนี้ได้รับใบอนุญาตภายใต้ใบอนุญาต MIT
ขอบคุณมากในการพัฒนา AI และแยกกันเป็นсhatgptสำหรับการสร้าง readme
และยัง ACHEONG08 สำหรับการสร้าง CHATGPT