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 개발 종속성으로 설치

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 키

OPENAI_API_KEY 사용하여 루트 디렉터리에 .env 파일을 추가합니다.

또는 OPENAI_API_KEY 시스템 환경 변수로 설정하세요.

여기서 API 키를 찾으세요

이 프로젝트를 문서화하세요

복제된 저장소에서 docself 실행하면 ./src/ 에 소스 파일이 문서화됩니다.

npm run docself

복제된 저장소에서 test 실행하면 ./example/example.js 문서화됩니다.

npm run test 

기여

건설적인 비판, 이슈 및 PR은 환영합니다!

---

MIT 라이센스