AutoDoc ChatGPT

Autodoc-Chatgpt

AutoDoc-Chatgpt는 Chatgpt 모델의 힘을 활용하여 모든 프로그래밍 언어에 대한 문서를 자동으로 생성하는 Python 스크립트입니다.

AutoDoc-ChatGpt를 사용하면 코드베이스에 대한 포괄적 인 문서를 쉽게 생성 할 수 있습니다. 문서화하려는 파일의 경로를 제공하면 AutoDoc-Chatgpt가 자연어로 기능, 매개 변수 및 반환 값에 대한 자세한 설명을 생성합니다.

시작하기

설치

이 저장소를 로컬 컴퓨터로 복제하십시오.

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

그런 다음 필요한 패키지를 설치하십시오.

pip install -r requirements.txt

지원되는 프로그래밍 언어

• 파이썬
• 자바 스크립트
• TypeScript
• 가다
• 기음#
• C ++
• PHP
• 루비
• 녹
• 자바
• 코 틀린

그리고 다른 것들 ...

disclaimer : TypeScript 및 Javscript에는 몇 가지 버그가 있으며 테스트 중입니다.

disclaimer_2.0 : 이름이 같은 메소드가있는 2 개 이상의 클래스가있는 파일에 알려진 오류가 있습니다.

용법

구성 편집

Oauth 인증을 사용하지 않는 경우 config.ini 열고 email 과 password 추가하십시오. 그렇지 않으면 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 

부인 성명

항상 올바른 댓글을 작성하지는 않습니다. 항상 원하는 것을 의미하는 것은 아닙니다. 편집해야 할 주석 초안으로 사용하십시오.

특허

이 프로젝트는 MIT 라이센스에 따라 라이센스가 부여됩니다.

감사의 말

README를 생성하기 위해 AI의 개발에 감사드립니다.

또한 chatgpt를 만들기위한 Acheong08.