AutoDoc ChatGPT

Autodoc-Chatgpt

AutoDoc-Chatgpt是一個Python腳本，它利用ChatGpt模型的力量自動為任何編程語言生成文檔。

使用Autodoc-Chatgpt，您可以輕鬆地為代碼庫生成全面的文檔。只需提供您希望記錄的文件的路徑，AutoDoc-Chatgpt將生成其功能，參數和自然語言返回值的詳細說明。

入門

安裝

克隆此存儲庫到您的本地機器：

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

然後安裝所需的軟件包：

pip install -r requirements.txt

支持的編程語言

• Python
• JavaScript
• 打字稿
• 去
• C＃
• C ++
• php
• 紅寶石
• 銹
• 爪哇
• 科特林

還有其他...

disclaimer ：Typescript和Javscript有一些錯誤，並且正在測試

disclaimer_2.0 ：有一個已知的錯誤評論文件，其中有2個或多個類別具有相同名稱的方法。

用法

編輯配置

如果您不使用OAuth授權，則打開config.ini並在此處添加email和password 。否則，打開chatgpt並獲取__Secure-next-auth.session-token cookie並將其寫入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的開發，並分別感謝您產生了讀數。

還有Acheong08用於創建ChatGpt。