gptdoc

สร้างความคิดเห็นเกี่ยวกับเอกสารประกอบด้วยโมเดล OpenAI

ติดตั้ง • เอกสารประกอบ • ใบอนุญาต

ดูตัวอย่าง

ฟังก์ชั่นที่มีป้ายกำกับด้วย /** @gpt */ รับความคิดเห็นเกี่ยวกับเอกสารที่สร้างขึ้นอัตโนมัติ

ก่อน	หลังจาก
/** @gpt */ function Greet ( name ) { console . log ( `Hello ${ name } ` ) ; }	/** * @autogenerated * @summary Generates a greeting to the passed in name * @param {string} name - The name to greet */ function Greet ( name ) { console . log ( `Hello ${ name } ` ) ; }

ติดตั้งในโครงการ

ติดตั้ง gptdoc เป็นการพึ่งพา dev

npm i --save-dev gptdoc 

ดำเนินการ

node node_modules/gptdoc [args]

การกำหนดค่า

คุณสามารถระบุไฟล์การกำหนดค่า:

node node_modules/gptdoc -c .myconfig

หากไม่มีระบุไว้ สคริปต์จะค้นหา .gptdoc

ตัวอย่างไฟล์คอนฟิก

{
    "DEBUG" : false ,
    "framework" : " JSDOC " ,
    "language" : " JS " ,
    "files" : {
        "src" : " ./src " ,
        "dest" : " ./gpt "
    },
    "openai" : {
        "temperature" : 0.7 ,
        "top_p" : 1 ,
        "max_tokens" : 256 ,
        "model" : " text-davinci-003 "
    }
}

ค้นหาข้อมูลเพิ่มเติมเกี่ยวกับการกำหนดค่าได้ที่นี่

คีย์ API

เพิ่มไฟล์ .env ในไดเรกทอรีรากของคุณด้วย OPENAI_API_KEY

หรือตั้งค่า OPENAI_API_KEY เป็นตัวแปรสภาพแวดล้อมของระบบ

ค้นหาคีย์ API ของคุณที่นี่

เอกสารโครงการนี้

การรัน docself ใน repo ที่ถูกโคลนจะบันทึกไฟล์ต้นฉบับใน ./src/

npm run docself

การรัน test ใน repo ที่ถูกโคลนจะจัดทำเอกสาร ./example/example.js

npm run test 

มีส่วนร่วม

ยินดีต้อนรับคำวิจารณ์ที่สร้างสรรค์ ปัญหา และการประชาสัมพันธ์!

---

ใบอนุญาตเอ็มไอที