Создание комментариев к документации с помощью моделей 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
как зависимость для разработчиков.
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 "
}
}
Более подробную информацию о конфигурации можно найти здесь.
Добавьте файл .env
в корневой каталог с помощью OPENAI_API_KEY
или установите OPENAI_API_KEY
в качестве переменной системной среды.
найдите свой ключ API здесь
Запуск docself
в клонированном репозитории документирует исходные файлы в ./src/
npm run docself
Запуск test
в клонированном репозитории будет документировать ./example/example.js
npm run test
Конструктивная критика, вопросы и пиар более чем приветствуются!
Лицензия МТИ